Skip to content

Latest commit

 

History

History
98 lines (86 loc) · 4.98 KB

sandbox.md

File metadata and controls

98 lines (86 loc) · 4.98 KB
Raw

Step 1 Clone the frontend and backend repositories.

e.g.

mkdir soc-app
cd soc-app
git clone https://github.com/AndelaOSP/andela-societies-frontend
git clone https://github.com/AndelaOSP/andela-societies-backend

Ensure port 4021, 4022 and 4023 are not running on your machine.

Step 2 Set up the backend: Environment Variables

Change directory to the backend

cd andela-societies-backend

Ensure you have ALL your environment variables set in the src/.env file.

FLASK_APP=manage.py
PRIVATE_KEY_TEST=<value>
PUBLIC_KEY_TEST=<value>
PUBLIC_KEY=<value>
DEV_DATABASE=<value>
DATABASE_URL=<value>
APP_SETTINGS=<value>
ANDELA_API_URL=<value>
DEV_TOKEN=<value>
SENDER_CREDS=<value>
CIO=<value>
MAIL_SERVER=<value>
MAIL_PORT=<value>
MAIL_USE_TLS=<value>
MAIL_USERNAME=<value>
MAIL_PASSWORD=<value>

The value of these variables are obtained from the TTL, fellow developers in the team or the DevOps engineer in the team.

For the sandbox environment strictly:

  • Do not place export before the variable assignment in the .env file as this application uses dot-env e.g. This will not work as docker picks even the export name.
export PRIVATE_KEY_TEST=""
export PUBLIC_KEY_TEST=""
  • Do not assign double quotes[""] or single quotes[''] to any of the environment variables. e.g
Wrong implementation:
DEV_TOKEN="ewogICIrKysrKysrKysrKyI6IHsKICAgICItLS0tLS0tLS0tIjogIj09PT09PT09PT09PSIsCiAgICAiLS0tLS0tLS0iOiAiwqLCosKiwqLCosKiwqLCosKiwqLCosKiIiwKICAgICItLS0tLS0tLS0iOiAiIyMjIyMjIyMjIyMjIyMiLAogICAgIi0tLS0tLS0tIjogIsKjwqPCo8KjwqPCo8KjwqPCo8KjwqPCo8KjwqPCo8KjIiwKICAgICItLS0tLS0tLSI6ICItLS0tLS0tLS0tLS0iLAogICAgIi0tLS0tLS0tLS0tLS0iOiAiZW1wdHkiLAogICAgIi0tLS0tLS0tLS0tLSI6IHsKICAgICAgIi0tLS0tLS0tLS0tIjogIi0tLS0tLS0tLS0tLS0tLS0iLAogICAgICAiLS0tLS0tLS0tIjogIi0tLS0tLS0tLS0tLS0tLS0tLS0tIgogICAgfQogICAgIioqKioqKioqKioiOiB7CiAgICAgICJub3RoaW5nIjogIm5vdGhpbmciLAogICAgICAiemlwIjogInppcCB6aXAgemlwIgp9CiAgfSwKICAiaWF0IjogMDAwMDAwMDAwMDAwLAogICJleHAiOiAwMDAwMDAwMDAwMDAwLAp9Cg=="

Correct implementation:
DEV_TOKEN=ewogICIrKysrKysrKysrKyI6IHsKICAgICItLS0tLS0tLS0tIjogIj09PT09PT09PT09PSIsCiAgICAiLS0tLS0tLS0iOiAiwqLCosKiwqLCosKiwqLCosKiwqLCosKiIiwKICAgICItLS0tLS0tLS0iOiAiIyMjIyMjIyMjIyMjIyMiLAogICAgIi0tLS0tLS0tIjogIsKjwqPCo8KjwqPCo8KjwqPCo8KjwqPCo8KjwqPCo8KjIiwKICAgICItLS0tLS0tLSI6ICItLS0tLS0tLS0tLS0iLAogICAgIi0tLS0tLS0tLS0tLS0iOiAiZW1wdHkiLAogICAgIi0tLS0tLS0tLS0tLSI6IHsKICAgICAgIi0tLS0tLS0tLS0tIjogIi0tLS0tLS0tLS0tLS0tLS0iLAogICAgICAiLS0tLS0tLS0tIjogIi0tLS0tLS0tLS0tLS0tLS0tLS0tIgogICAgfQogICAgIioqKioqKioqKioiOiB7CiAgICAgICJub3RoaW5nIjogIm5vdGhpbmciLAogICAgICAiemlwIjogInppcCB6aXAgemlwIgp9CiAgfSwKICAiaWF0IjogMDAwMDAwMDAwMDAwLAogICJleHAiOiAwMDAwMDAwMDAwMDAwLAp9Cg==

Step 3 Start the backend

Ensure you are on the root of the folder andela-societies-backend and run the command below to start the backend application:

make start

If running the sandbox for the first time seed the database.

make seed

Step 4 Start the frontend application

Change directory into the andela-societies-frontend application and run the command below:

cd ../andela-societies-frontend
make start

Step 5 Other commands for the sandbox

While on the root of the folder for the frontend you can run the command:

  • make help: To determine all the commands you can run on the frontend.
  • make stop: To stop the frontend application and delete running containers.
  • make tear: To destroy resources for the frontend application. Sometimes the network may not be deleted if the backend is running. Just ignore the error

While on the root of the folder for the backend you can run the command:

  • make stop: To stop the backend application and delete running containers.
  • make tear: To destroy resources for the backend application. Sometimes the network may not be deleted if the frontend is running. Just ignore the error. Also while starting the application again after running this command you'll have to seed the database since the postgres database is deleted with this command.
  • make seed: To seed the database and link cohorts to societies. Should be done once after running make start for the first time or when a make tear has been run before and you desire to start the sandbox again.
  • make help: To determine all the commands you can run on the backend. Note: you'll meet a plethora of commands that do not relate to the sandbox.

Step 6 View the database

To view the database for the sandbox use the following credentials. (The database should be running.)

  • host: 127.0.0.1
  • user: soc
  • password: soc
  • database: soc-sandbox
  • port: 4023

Step 7 View logs for the application

Backend Logs

On the root of the backend repository you will be able to find application logs under the logs folder. This folder is created after starting the sandbox. This folder contains two files error.log and access.log. Application errors are logged to the error.log file while application access logs are logged to the access.log file.

#### Frontend Logs

Coming soon!!