Giter VIP home page Giter VIP logo

conmentarium's Introduction

Conmentarium

Minimalistic notebooks app built with React + Material-UI, and served with Flask. Star, fork or contribute if you wish so.

What you need to run this code locally (build folder)

  1. Python 3 installed
  2. Postgres database installed and running
  3. Install Dependecies in requirement.txt
  4. In the root of this directory:

Client /conmentarium

cd client
yarn (or npm install)
yarn build (or npm run build)

Server /conmentarium

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

  1. Clone this repository
  2. 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
  3. Open 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 or check out the offcial Heroku docs.

GitHub repository

[https://github.com/MurphyAdam/Conmentarium](https://github.com/MurphyAdam/ConmentariumConmentarium

conmentarium's People

Contributors

murphyadam avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.