Skip to content

Commit

Permalink
Merge branch 'develop' into timi-codes-patch-2
Browse files Browse the repository at this point in the history
  • Loading branch information
timi-codes authored Oct 9, 2024
2 parents 8fae37c + 7864ba6 commit ac55d2a
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,18 @@ Manage, track, and analyze the value of your digital assets, including NFTs (ERC
- Clone the repository
> Run the command below
```shell
$ git clone https://github.com/timi-codes/coinfolio-api.git
git clone https://github.com/timi-codes/coinfolio-api.git
```

- Install dependencies
> Run the command below
```shell
$ yarn install
yarn install
```

- Create a `.env` file in the root of the project and add the following environment variables:
```shell
$ cp .env.example .env
cp .env.example .env
```
<details>
<summary>How to setup environment variables</summary>
Expand Down Expand Up @@ -104,16 +104,16 @@ Manage, track, and analyze the value of your digital assets, including NFTs (ERC
- Run migrations
> Run the command below to create the database schema
```shell
$ yarn run db:migrate
yarn run db:migrate
```
Other commands:
```bash
# create a new migration
$ yarn run migrate:create <migration_name>
yarn run migrate:create <migration_name>
# run the next migration
$ yarn run db:migrate:up
yarn run db:migrate:up
# rollback the last migration
$ yarn run db:migrate:down
yarn run db:migrate:down
# rollback all migrations
yarn run db:rollback
# create a new seed
Expand All @@ -125,7 +125,7 @@ Manage, track, and analyze the value of your digital assets, including NFTs (ERC
- Run the project
> Run the command below to start the project
```shell
$ yarn run start:dev
yarn run start:dev
```

- Navigate to `http://localhost:4000/api-docs` to access the API documentation
Expand All @@ -136,13 +136,13 @@ Manage, track, and analyze the value of your digital assets, including NFTs (ERC
- Run migrations
> Run the command below to create the database schema
```shell
$ docker compose run coinfolio-api yarn run db:migrate
docker compose run coinfolio-api yarn run db:migrate
```

- Run the project
> Run the command below to start the project
```shell
$ docker compose up -d --build
docker compose up -d --build
```

- Navigate to `http://localhost:4000/api-docs` to access the API documentation
Expand Down

0 comments on commit ac55d2a

Please sign in to comment.