Skip to content

Commit

Permalink
Fix docker compose and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
0xLucca committed Jan 15, 2024
1 parent b281059 commit c0e29e3
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 1,457 deletions.
3 changes: 0 additions & 3 deletions .docker/web/.env_web
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,3 @@ NEXT_DB_PORT=23798

# SQUID
NEXT_SHIBUYA_GQL_ENDPOINT="http://localhost:4350/graphql"

# TESTS
RUN_REAL_API_TESTS="false"
10 changes: 0 additions & 10 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,12 +1,2 @@
# DB
NEXT_DB_NAME="databaseName"
NEXT_DB_USER="user"
NEXT_DB_PASS="pass"
NEXT_DB_HOST="domaindatabase.com"
NEXT_DB_PORT=33436

# SQUID
NEXT_SHIBUYA_GQL_ENDPOINT="http://18.118.77.170:4350/graphql"

# TESTS
RUN_REAL_API_TESTS="false"
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ To run this project, you will need:

### Docker Setup

First you need to create a .env file in the root directory of the project. You must copy the variables in the ./docker/web/.env_web.example file running the following command:

```bash
cp .docker/web/.env_web .env
```

To run the web app along with the Squid node, follow these steps:

- Execute the following command to instantiate all necessary components. Note that it is crucial to wait for the Squid node to be fully synchronized before proceeding and using the app.
Expand All @@ -27,8 +33,13 @@ To run the web app along with the Squid node, follow these steps:

- If you prefer running the app without a local Squid node, you can do the following:

1. Open the .docker/web/.env_web file.
2. Modify the NEXT_SHIBUYA_GQL_ENDPOINT variable to point to the provided test node.
1. Open the .env file.
2. Modify the NEXT_SHIBUYA_GQL_ENDPOINT variable to the provided test node.

```
NEXT_SHIBUYA_GQL_ENDPOINT="http://18.118.77.170:4350/graphql"
```

3. Run the app using the command:

```bash
Expand All @@ -44,6 +55,12 @@ docker-compose down
### Local Stack

- Install the dependencies with `yarn`
- Create a `.env` file in the root directory of the project. You must copy the variables in the `.env.example` file running the following command:

```bash
cp .env.example .env
```

- Run the app with `yarn dev`

### 🎨 Run Storybook
Expand Down
Loading

0 comments on commit c0e29e3

Please sign in to comment.