{"id":22615578,"url":"https://github.com/marcellodesales/x-crypt0-surf3rs-nft","last_synced_at":"2026-07-14T19:32:12.028Z","repository":{"id":142073151,"uuid":"461841014","full_name":"marcellodesales/x-crypt0-surf3rs-nft","owner":"marcellodesales","description":"A collect of crypto surfers nfts","archived":false,"fork":false,"pushed_at":"2022-02-21T11:59:19.000Z","size":8129,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-20T06:50:59.977Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcellodesales.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-21T11:59:13.000Z","updated_at":"2022-02-21T11:59:23.000Z","dependencies_parsed_at":"2023-07-09T05:31:56.511Z","dependency_job_id":null,"html_url":"https://github.com/marcellodesales/x-crypt0-surf3rs-nft","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"FilosofiaCodigo/nft-collection-api","purl":"pkg:github/marcellodesales/x-crypt0-surf3rs-nft","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcellodesales%2Fx-crypt0-surf3rs-nft","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcellodesales%2Fx-crypt0-surf3rs-nft/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcellodesales%2Fx-crypt0-surf3rs-nft/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcellodesales%2Fx-crypt0-surf3rs-nft/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcellodesales","download_url":"https://codeload.github.com/marcellodesales/x-crypt0-surf3rs-nft/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcellodesales%2Fx-crypt0-surf3rs-nft/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35476729,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-14T02:00:06.603Z","response_time":114,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-08T19:08:24.483Z","updated_at":"2026-07-14T19:32:12.009Z","avatar_url":"https://github.com/marcellodesales.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NFT Collection API 🖼️\n\nJSON API that servers ERC-721 compatible metadata for an NFT collection on the blockchain.\n\n## Features 👀\n\n| Feature | Supported |\n|----------|------------ |\n| MIT License | ✔ |\n| Hide non minted NFTs | ✔ |\n| Shuffle | ✔ |\n| Reveal | ✔ |\n| Handle _none_ traits | ✔ |\n| IPFS | ✔ |\n| Google Cloud Storage | ✔ |\n\n## Dependencies ⚒\n\n```\nnpm install\n```\n\n## Run 🚀\n\n## Development mode\n\n```\nnpm start\n```\n\n## Production mode commands\n\n```\nnpm i -g pm2\npm2 start main.js\npm2 kill\npm2 list\npm2 restart\npm2 stop [ID]\n```\n\n## Auxiliary Scripts 👩‍⚕️\n\n* `npm run shuffle`: randomizes the metadata to make the minting process exciting\n* `npm run upload_images_update`: uploads images to IPFS\n* `npm run upload_images_ipfs`: uploads images to IPFS\n* `npm run upload_images_gcs`: uploads images to Google Cloud Storage. Just make sure you have your `gcs.json` keyfile on the project directory\n* `npm run remove_none_traits`: removes all traits marked as \"none\" to make the metadata rarity.tools friendly\n\n## Checklist 📝\n\nMake sure you follow all these steps when launching this API:\n\n1. Upload this project to a linux virtual machine on the cloud (digital ocean, amazon web services etc..)\n2. Replace your contract ABI `./Contract.json`\n3. Replace your un revealed image on `./unrevealed/image.png`\n4. Set the variables on the top of `scripts/start.js`, keep the `IS_REVEALED` variable set to `false` to start the server with _unrevealed mode_\n5. Start the server with `npm start`\n6. Put all your images and metadata on `./images/` and `./metadata/` respectively\n  * Consider using FTP or scp, for example: `scp -r user@ssh.example.com:/path/to/remote/source /path/to/local/destination`\n8. run `npm run shuffle`\n9. run `npm run remove_none_traits` if needed\n10. Upload your images, choose between CGS or IPFS\n  * IPFS\n    * Run `npm run upload_images_ipfs`\n  * Google Cloud Services\n    * Put your `gcs.json` keyfile on this project directory\n    * Run `npm run upload_images_gcs`\n    * Install the google cloud console and run this to open the files in the browser instead of downloading them by downloading the Google Cloud SDK and running this: `gsutil -m setmeta -h \"Content-Type: image/png\" -h \"Content-Disposition: inline;\" gs://YOURBUCKETNAME/*`. Remember to set `YOURBUCKETNAME`.\n11. Once you want to reveal the Images and Metadata set the `IS_REVEALED` to `true` on `scripts/start.js`, stop and restart the server\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcellodesales%2Fx-crypt0-surf3rs-nft","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcellodesales%2Fx-crypt0-surf3rs-nft","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcellodesales%2Fx-crypt0-surf3rs-nft/lists"}