|
|
@@ -1,6 +1,6 @@
|
|
|
# Getting Started
|
|
|
|
|
|
-After forking and cloning the repo, you should save two `.env` files in the repo.
|
|
|
+After forking and cloning the repo, you should save two `.env` files in the repo.
|
|
|
|
|
|
First, in `/dashboard/.env`:
|
|
|
|
|
|
@@ -22,4 +22,34 @@ DB_NAME=porter
|
|
|
SQL_LITE=false
|
|
|
```
|
|
|
|
|
|
-Once you've done this, go to the root repository, and run `docker-compose -f docker-compose.dev.yaml up`. You should see postgres, webpack, and porter containers spin up. When the webpack and porter containers have finished compiling and have spun up successfully (this will take 5-10 minutes after the containers start), you can navigate to `localhost:8080` and you should be greeted with the "Log In" screen. At this point, you can make a change to any `.go` file to trigger a backend rebuild, and any file in `/dashboard/src` to trigger a hot reload.
|
|
|
+Once you've done this, go to the root repository, and run `docker-compose -f docker-compose.dev.yaml up`. You should see postgres, webpack, and porter containers spin up. When the webpack and porter containers have finished compiling and have spun up successfully (this will take 5-10 minutes after the containers start), you can navigate to `localhost:8080` and you should be greeted with the "Log In" screen. At this point, you can make a change to any `.go` file to trigger a backend rebuild, and any file in `/dashboard/src` to trigger a hot reload.
|
|
|
+
|
|
|
+## Setup for WSL
|
|
|
+
|
|
|
+Follow the steps to install WSL on Windows here https://docs.microsoft.com/en-us/windows/wsl/install-win10
|
|
|
+
|
|
|
+### Requirements
|
|
|
+
|
|
|
+`sudo apt install xdg-utils` <br/>
|
|
|
+`sudo apt install postgres`
|
|
|
+
|
|
|
+### Setup Proccess
|
|
|
+
|
|
|
+Once WSL is installed, head to docker and enable WSL Integration.
|
|
|
+
|
|
|
+
|
|
|
+Once you've done this, go to the root repository, and run `docker-compose -f docker-compose.dev.yaml up`.
|
|
|
+
|
|
|
+When the webpack and porter containers have finished compiling and have spun up successfully, you can navigate to `localhost:8080`, and you should be greeted with the "Log In" screen.
|
|
|
+
|
|
|
+Next, Register your admin account. Once it's complete, it will ask you to verify your Email; we will manually verify it through Postgres.
|
|
|
+
|
|
|
+Open your terminal in the root repository and enter:
|
|
|
+
|
|
|
+`psql --host localhost --port 5400 --username porter --dbname porter -W`
|
|
|
+
|
|
|
+It will promt you for a password. Enter `porter`
|
|
|
+
|
|
|
+Next, verify your email.
|
|
|
+
|
|
|
+`UPDATE users SET email_verified='t' WHERE id=1;`
|