How to run¶

How to run the backend¶

You will need Python >= 3.4 (Python 2 is not supported sorry)

Many ways to run this:

Cloning the repo
1. Clone the repo
  git clone https://github.com/cenotes/cenotes.git
2. Install the requirements
  - With pipenv (suggested)
    
    pip install pipenv pipenv --three install
  - With pip (not suggested):
    
    pip install -r requirements-dev.txt
3. Set the environment variables as shown in Settings
4. Set your PYTHONPATH to include the project
  export PYTHONPATH=<path-to-the-cloned-repo>:$PYTHONPATH
5. Check your database table as shown in Settings is up-to-date
  python manage.py db upgrade
6. Run the backend
  python run_backend.py --help
Installing the package
1. Install the package
  sudo pip install cenotes
2. Set the environment variables as shown in Settings
3. Run the backend
  cenotes --help

How to run the cli¶

You will need python >= 3.3

Cloning the repo

Clone the repo

git clone https://github.com/cenotes/cenotes-cli.git

Install the requirements with pipenv
```
pip install pipenv
pipenv install
```
Set your PYTHONPATH to include the project

For linux:

export PYTHONPATH=<path-to-the-cloned-repo>:$PYTHONPATH

See available options
```
python cenotes_cli/cli.py --help
```

Installing the python package
- Ideally inside a virtualenv
```
pip install cenotes-cli
```

See available options
cenotes-cli --help

How to run the frontend¶

Cloning the repo and running the NodeJS server with the React components 1. Clone the repo

git clone https://github.com/cenotes/cenotes-reaction.git

Install the dependencies
```
npm install
```
Start the server
```
npm run start
```