Skip to content

Commit

Permalink
chore: update gitignore & readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Majorfi committed Mar 28, 2024
1 parent 75de9ae commit 9bc1f5f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,6 @@ yarn-error.log*
# typescript
*.tsbuildinfo
next-env.d.ts

_config/_goAPI/vendor
_config/_goAPI/assets
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,27 @@ Currently the API/CDN endpoint is at:
https://assets.smold.app/api/token/[chainID]/[tokenAddress]/[fileName].[ext]
```

## Usage

It's recommanded to use PNG files. They are smaller and faster to load, come in two sizes (32x32 and 128x128) and are supported by all browsers.
SVG files are also available, but they are larger and slower to load and can hurt performances for poorly optimized assets or very complex ones (ex: curvefi icon).

## (Self) Hosting

The repo comes with two different server systems in `_config`:
- a `golang` server, that serve the assets from github
- a `node` server, configured to work with Vercel. If you want to self host, here is the config we are using:
```
Framework Preset: Next.js
Build Command: yarn --cwd _config/nodeAPI/ run build
Output Directory: _config/nodeAPI/.next
Install Command: yarn install && yarn --cwd _config/nodeAPI/ install
Development Command: next
Node Version: 18.x
Environment Variables: None
```


## Contributing

You will need an SVG file of the logo of the asset. You can use
Expand Down

0 comments on commit 9bc1f5f

Please sign in to comment.