mirror of
https://github.com/stronk-dev/RandomChad.git
synced 2025-07-05 02:35:08 +02:00
Readme scaffold
This commit is contained in:
parent
e762553faf
commit
1f2a2c1fd4
34
README.md
Normal file
34
README.md
Normal file
@ -0,0 +1,34 @@
|
||||
# Rocketeer NFT
|
||||
|
||||
Components:
|
||||
|
||||
- Solidity contract
|
||||
- Firebase function for metadata
|
||||
|
||||
Project structure:
|
||||
|
||||
```
|
||||
|
||||
./
|
||||
./*.{json,rules,js}
|
||||
./- config files for the contracts and API
|
||||
|
||||
./contracts/
|
||||
./- Solidity contracts
|
||||
|
||||
./migrations/
|
||||
./- Migrations for the contracts
|
||||
|
||||
./test/
|
||||
./- Tests for the contacts
|
||||
|
||||
./functions/
|
||||
./- Firebase API code
|
||||
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
[ ] `./functions`: set Infura project ID through `firebase functions:config:set infura.projectid=`
|
||||
[ ] `./functions/package.json`: dependencies for backend, run `npm i` in `./functions`
|
||||
[ ] `./package.json`: dependencies for contracts, run `npm i` in root
|
Loading…
x
Reference in New Issue
Block a user