Skip to content

Commit

Permalink
moved build.md to the docs folder
Browse files Browse the repository at this point in the history
  • Loading branch information
siv2r committed Jun 8, 2021
1 parent acaaf5b commit 74ac359
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Setting up this project

### Method 1 (Manual setup)
This method is recommended if you are working on the backend of this project.

Explained in this [document](https://www.notion.so/Project-setup-Public-1a647ed8515c485f99f38e717acfa61b)

Detailed Step by step [Video](https://drive.google.com/file/d/11n6k2obh5k-06-gYq8GWAo0Rw4aY9G7w/view)

### Method 2 (Through Docker)
This method will be sufficient if you are working only on the frontend of this project.

How to run the server (Optional)

1. Install Docker
2. Run `docker-compose up` inside the project root folder

Done! Now you should be able to access the project at **0.0.0.0:8080** or **localhost:8080**. And you should just refresh the page to see your changes.

0 comments on commit 74ac359

Please sign in to comment.