README.md

Model Garden

‍🖌️ Material Design: Intuitive UI based on the world's most widespread design language.

🏃 Single Page Application: Fast, responsive UX increase productivity and avoids fullscreen refreshes.

🐍 Python Django and Postgres

Table of Contents

• Install docker

• Run Database and Backend from Docker

• Setup Front-end Locally

• Learn More

Run Database and Backend from Docker

1. Create <model_garden_root>/backend/.env. Ask colleagues to share this file content.
2. Build Docker Image: <model_garden_root>/backend/README.md#build-docker-image.
3. Run the database container:

docker-compose up -d postgres

4. Run the backend container:

docker-compose up -d backend

5. Run the worker container:

docker-compose up -d worker 

Setup Front-end Locally

1. Add <model_garden_root>/frontend/.env if absent.

2. Setup local backend and frontend ports in <model_garden_root>/frontend/.env:

PORT=4200
REACT_APP_BACKEND_PORT=9000

3. Install packages in <model_garden_root>/frontend/ dir

npm install

4. Run front-end in <model_garden_root>/frontend/ dir

npm start

Run Linting

To run additional JS-lint use npm run lint -s in <model_garden_root>/frontend/ dir.

Learn More

This project was bootstrapped with Create React App.