capstone-project-masterminds

capstone-project-masterminds created by GitHub Classroom

Boilerplate credits: https://github.com/kingbar1990/React-TypeScript-Flask-boilerplate

Build project

1. Rename ".env.example" to ".env"

mv .env.example .env

2. Create files folder

mkdir server/files

3. Build docker-compose

docker-compose build

4. Create database

docker-compose up -d database

5. Make database migrations

docker-compose run flask python manage.py db upgrade

6. Create node_modules

docker-compose run node yarn

7. Run the project

docker-compose up

8. Open in your browser http://localhost:3000/

Steps to run the server

1. Change directory to server

cd server

2. Install dependencies

pip install -r requirements.txt

3. Change DB details if required in config.py

SQLALCHEMY_DATABASE_URI = 'postgresql+psycopg2://{user}:{passwd}@{host}:5432/{db}'.format(
        user="username",
        passwd="password",
        host="localhost",
        db="Waitless"
)

4. Start the server

python manage.py

Run tests

docker-compose run flask pytest