https://github.com/reuseman/gooutsafe

🍲 Restaurant reservation platform with user tracking capabilities for Covid-19.
https://github.com/reuseman/gooutsafe

covid-19 flask monolith unipi

Last synced: 5 months ago
JSON representation

🍲 Restaurant reservation platform with user tracking capabilities for Covid-19.

• Host: GitHub
• URL: https://github.com/reuseman/gooutsafe
• Owner: reuseman
• License: other
• Created: 2020-10-23T08:02:29.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2020-11-23T19:45:50.000Z (over 5 years ago)
• Last Synced: 2025-04-08T11:18:29.891Z (about 1 year ago)
• Topics: covid-19, flask, monolith, unipi
• Language: Python
• Homepage:
• Size: 3.39 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/reuseman/GoOutSafe.svg?branch=main)](https://travis-ci.org/reuseman/GoOutSafe) [![Coverage Status](https://coveralls.io/repos/github/reuseman/GoOutSafe/badge.svg?branch=main)](https://coveralls.io/github/reuseman/GoOutSafe?branch=main) [![Requirements Status](https://requires.io/github/reuseman/GoOutSafe/requirements.svg?branch=main)](https://requires.io/github/reuseman/GoOutSafe/requirements/?branch=main)

# Getting started

## Development

### Local

    # Install Dependencies

    pip install -r requirements/dev.txt

    # Deploy

    flask deploy

    # Start Server mail

    python -m smtpd -n -c DebuggingServer localhost:8025

    # Start Redis

    docker run --name redis -p 6379:6379 redis

    # Start Celery

    celery -A gooutsafe.celery worker -l DEBUG -E -B

    # Start Elasticsearch

    docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:7.10.0

    

    # Run 

    export FLASK_APP="gooutsafe"

    export FLASK_ENV=development

    flask run

### Docker Image

    docker build -t gooutsafe:latest . 

To run with settings

    docker run --name gooutsafe -d -p 8000:5000 --rm -e SECRET_KEY=my-secret-key \

        -e MAIL_SERVER=smtp.gmail.com -e MAIL_PORT=587 -e MAIL_USE_TLS=1 \

        -e MAIL_USERNAME= -e MAIL_PASSWORD= \ gooutsafe:latest

To run without settings

    docker run --name gooutsafe -d -p 8000:5000 --rm gooutsafe:latest

#### If no mail is provided, run the following for a mock smtp

    python -m smtpd -n -c DebuggingServer localhost:8025

### Docker-compose

Create a `.env` file with the environment variables requested by docker-compose.yml

    docker-compose build

    docker-compose --env-file .env up

## Tests with coverage

Inside GoOutSafe run (it will automatically use the configuration in pyproject.toml):

    pytest

If you want to see an interactive report run:

    coverage html

## Documentation

### User stories

![](docs/user-stories.png)

### E-R Diagram in PlantUML

![](docs/plantUML-er.png)