Skip to content

Commit

Permalink
Scarb fmt and readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
b-j-roberts committed Apr 7, 2024
1 parent 9ebeafd commit 48ac736
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 16 deletions.
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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

Expand Down
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,41 +24,52 @@ 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
```

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

Expand Down
2 changes: 1 addition & 1 deletion onchain/src/tests/art_peace.cairo
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 48ac736

Please sign in to comment.