CONTRIBUTING.md

Developer

• Notes for installing dependencies needed to run the app locally with Flask.
• Notes for how to deploy application to Github Pages.

Installation

• Node.js / npm

  • Javascript Pacakge Manager - npm
  • Javascript Bundler - webpack

• git clone https://github.com/brio50/divisor.git

• npm install - see package.json

Local Development

npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=brio50 USE_SSH=1 npm run deploy

GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

References

At the start of this project I used Python, Flask, and Jinja2 to build a local web server and figured out how to embed React and Bootstrap to get the front-end of the website the way I wanted. After getting frustrated with that, I simply decided to go full Javascript and leveraged https://create-react-app.dev/ to re-build the tech stack from the ground up. The first attempt brought a lot of lessons learned, which made the second go much faster!

First Attempt

• .gitignore LF vs CLRF
• npm github pages
• react docs (deprecated)
• Flask Application Factory

Second Attempt

• create-react-app

Inspiration

• Flask-React-Boilerplate