From 0323cf430926e3c4c6dbc0d8c0c19e176ea822bb Mon Sep 17 00:00:00 2001 From: Timi Tejumola Date: Tue, 8 Oct 2024 23:36:08 -0400 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 40ab903..bfd5acc 100644 --- a/README.md +++ b/README.md @@ -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/coinfolio-io/coinfolio-api.git + git clone https://github.com/coinfolio-io/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 ```
How to setup environment variables @@ -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 + yarn run migrate:create # 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 @@ -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 @@ -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