Minimalistic notebooks app built with React + Material-UI, and served with Flask. Star, fork or contribute if you wish so.
- Python 3 installed
- Postgres database installed and running
- Install Dependecies in requirement.txt
- In the root of this directory:
cd client
yarn (or npm install)
yarn build (or npm run build)
flask db init
flask db migrate
flask db upgrade
flask run
- Node (v14.7.0)
- NPM (6.14.7) or Yarn (1.22.4)
- Install client-side dependencies (see below)
- Python and PIP
- install server-side dependencies (see below)
- Clone this repository
- Open command line in the cloned folder,
- To install client side dependencies, run
npm install
oryarn
- To install server side dependencies,
pip install -r requirements.txt
- To run the client side application in development, run
npm start
oryarn start
- To install client side dependencies, run
- Open localhost:3000 in the browser
file config.py in the root directory of this app contains all the neccessary configs for our Flask app. It contains mainly three classes: Config, Development, and Testing. The latter two all inherit from Config. If you planning on running locally (development), please go to server/init.py and in the create_app()
function's config_class parameter, pass in the class Development instead of Config. Leave as Config for deployment.
You may change the config variables in each class as you wish.
Everything is already set up for your to deploy this app to Heroku. All you need is to create a new app at Heroku and push this repository to it. Learn more on doing so on Flask PWA Chatterbot: Deployment on Heroku or check out the offcial Heroku docs.
[https://github.com/MurphyAdam/Conmentarium](https://github.com/MurphyAdam/ConmentariumConmentarium