Skip to content

Latest commit

 

History

History
58 lines (50 loc) · 1.73 KB

README.md

File metadata and controls

58 lines (50 loc) · 1.73 KB

Stats App

Start

Run these at root of project

    1. Make .env file @ root and copy contents of .env.example into it
    1. pipenv shell
    1. ./build.sh
    1. ./start_prod.sh

To get needed items

  • install Python Ubuntu
sudo apt install python3 python3-pip
  • install Python Fedora
sudo dnf install python3 python3-pip
  • install Python Arch
sudo pacman -S python3-pip
  • install pipenv
pip install --user pipenv

*** NOTE: If you are using zsh shell, some configuration may be required

  • Install venv wrapper for oh-my-zsh pip install virtualenvwrapper
  • In the .zshrc, add these lines to direct virtual environment to the project
export VIRTUALENVWRAPPER_PYTHON=$(which python3)

plugins=(
        "existing plugins"
        ...
        virtualenvwrapper
    )

BASIC ARCHITECTURE

The app uses the Python Web framework called Django

It utilizes a sqlite db for development and is setup for postgres in production

The web app is handled via Django's templating

It does not make use of any front end tools

CI/CD is setup to be used via github

It is optimized to be launched to render, unfortunately it turns out that Render's free tier does not make a stable release due to slow dynos. Alternative options for deployment could be AWS Beanstalk or fly.io.

The app does not have need for an API, but is setup for building one if needed in the future

CONSIDERATIONS

If I were to do it over, I would use Svelte to build the static files, this would save time on development

COMMANDS

  • ./build.sh This command will build the static file and apply migrations
  • ./start.sh This command starts the app with pip
  • ./start_prod.sh This command starts the app with gunicorn