diff --git a/Makefile b/Makefile index a0b07979..05ae8f53 100644 --- a/Makefile +++ b/Makefile @@ -1,15 +1,15 @@ -build: backend-build frontend-build contracts-build +build: build-backend build-frontend build-contracts test: contracts-test -backend-build: +build-backend: @echo "Building backend..." @cd backend && go build -frontend-build: +build-frontend: @echo "Building frontend..." @cd frontend && npm run build -contracts-build: +build-contracts: @echo "Building contracts..." @cd onchain && scarb build diff --git a/README.md b/README.md index 1782ed09..c274097b 100644 --- a/README.md +++ b/README.md @@ -24,24 +24,24 @@ Some of the features include : ## Running -TODO: Note build and run for each modules +### Docker ( Recommended ) -#### Docker ( Recommended ) -``` +```bash docker compose up ``` To stop the run use `Ctrl-C`. For a complete reset of the state and rebuild of the containers use : -``` +```bash # WARNING! This will clear the state (volumes) of all the DBs and the Devnet docker compose down --volumes docker compose build ``` -#### Local -``` +### Local + +```bash # Must install all the dependencies first # Change the user on `configs/database.config.json` for postgres make integration-test-local @@ -49,16 +49,27 @@ make integration-test-local To stop the run use `Ctrl-C`. +### Module + +Each module can also be run individually, check the **Modules** section below for more details. + ## Build -TODO: Note build and run for each modules -#### Docker ( Recommended ) -``` +### Docker ( Recommended ) + +```bash docker compose build ``` -#### Local -Use the `make X-build` command for each corresponding module `X`. See the **Modules** section below for more details. +### Local + +```bash +make build +``` + +### Module + +Use the `make build-X` command for each corresponding module `X`. See the **Modules** section below for more details. ## Modules diff --git a/onchain/src/tests/art_peace.cairo b/onchain/src/tests/art_peace.cairo index 481e3479..d8dd9163 100644 --- a/onchain/src/tests/art_peace.cairo +++ b/onchain/src/tests/art_peace.cairo @@ -102,7 +102,7 @@ fn deploy_test() { assert!( art_peace.get_total_pixels() == WIDTH * HEIGHT, "Deployed contract has wrong total pixels" ); - // TODO: Other getters & asserts +// TODO: Other getters & asserts } // TODO: To fuzz test