Skip to content

Commit 47cac80

Browse files
Update README.md
1 parent a56352a commit 47cac80

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ We recommend using our production environment for testing. You can find the prod
66

77
## DISCLAIMER: Our executor service can only run on x86_64 architecture. If you are using a different architecture, you will not be able to run the executor locally. However, you can still test the rest of the application.
88

9-
1. Install Docker for your operating system. You can find the installation instructions [here](https://docs.docker.com/get-docker/).
10-
2. Clone the repository.
11-
3. In the frontend folder, add .env file with the following content:
9+
- Install Docker for your operating system. You can find the installation instructions [here](https://docs.docker.com/get-docker/).
10+
- Clone the repository.
11+
- Run `git submodule update --init` to clone the submodules.
12+
- In the frontend folder, add .env file with the following content:
1213

1314
```
1415
NEXT_PUBLIC_FIREBASE_API_KEY=AIzaSyAMiTV5yv2D-gvCy2TNEFREZIMUJ3SnYD8
@@ -23,7 +24,7 @@ NEXT_PUBLIC_PEERPREP_INNKEEPER_SOCKET_URL=localhost
2324

2425
Note that usually these values are kept secret, but since this is a test environment, we are not concerned about security.
2526

26-
4. In the root folder, add .env file with the following content:
27+
- In the root folder, add .env file with the following content:
2728

2829
```
2930
POSTGRES_USER=peerprep
@@ -37,7 +38,7 @@ INITIALIZATION_VECTOR=vector
3738
ENCRYPTION_KEY=key
3839
```
3940

40-
5. In the firebase-auth folder, add service-account.json (file name has to be exact match) file with the following content:
41+
- In the firebase-auth folder, add service-account.json (file name has to be exact match) file with the following content:
4142

4243
```
4344
{
@@ -57,14 +58,14 @@ ENCRYPTION_KEY=key
5758

5859
Note that usually these values are kept secret, but since this is a test environment, we are not concerned about security.
5960

60-
6. In the root folder, run `docker compose -f docker-compose.yml up -d`.
61+
- In the root folder, run `docker compose -f docker-compose.yml up -d`.
6162

62-
7. Application should be running at [http://localhost](http://localhost).
63+
- Application should be running at [http://localhost](http://localhost).
6364

6465
# Giving yourself admin privileges
6566

66-
1. Login to the application in your browser using Google/Github.
67-
2. Run the following commands in your terminal:
67+
- Login to the application in your browser using Google/Github.
68+
- Run the following commands in your terminal:
6869

6970
```
7071
docker exec -it peerprep-postgres bash

0 commit comments

Comments
 (0)