Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/murphyadam/conmentarium
Conmentarium, a simple notebook for all ideas.
https://github.com/murphyadam/conmentarium
flask heroku javascript material-ui python react
Last synced: about 2 months ago
JSON representation
Conmentarium, a simple notebook for all ideas.
- Host: GitHub
- URL: https://github.com/murphyadam/conmentarium
- Owner: MurphyAdam
- Created: 2020-09-13T17:59:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-24T09:52:37.000Z (over 3 years ago)
- Last Synced: 2023-08-06T16:13:48.042Z (over 1 year ago)
- Topics: flask, heroku, javascript, material-ui, python, react
- Language: JavaScript
- Homepage: https://conmentarium.herokuapp.com/
- Size: 2.63 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Conmentarium
Minimalistic notebooks app built with React + Material-UI, and served with Flask. Star, fork or contribute if you wish so.
### [live Demo](https://conmentarium.herokuapp.com/ "Conmentarium")
#### What you need to run this code locally (build folder)
1. Python 3 installed
2. Postgres database installed and running
2. Install Dependecies in requirement.txt
3. In the root of this directory:
#### Client /conmentarium
```bash
cd client
yarn (or npm install)
yarn build (or npm run build)
```
#### Server /conmentarium
```bash
flask db init
flask db migrate
flask db upgrade
flask run
```
#### What you need to develop this code locally
#### Client-side
1. Node (v14.7.0)
2. NPM (6.14.7) or Yarn (1.22.4)
3. Install client-side dependencies (see below)
#### Server-side
1. Python and PIP
2. install server-side dependencies (see below)
#### How to develop this code
2. Clone this repository
3. Open command line in the cloned folder,
- To install client side dependencies, run ``` npm install ``` or ``` yarn ```
- To install server side dependencies, ```pip install -r requirements.txt```
- To run the client side application in development, run ``` npm start ``` or ``` yarn start ```
4. Open [localhost:3000](http://localhost:3000/) in the browser
----
### Server-side Configs
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.
### Deploy to Heroku
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
](https://langcodex.herokuapp.com/posts/34) or check out the offcial Heroku docs.
### GitHub repository
[https://github.com/MurphyAdam/Conmentarium](https://github.com/MurphyAdam/ConmentariumConmentarium