cornel/libracours repository overview

⁠Libracours⁠

⁠How to install and run (*nix friendly guide)

⁠Prerequisites

1. Install pip

wget https://bootstrap.pypa.io/get-pip.py
sudo python get-pip.py

1. Install virtualenv (Optional but highly recommended)

sudo pip install virtualenv

⁠Download, set up and run the project

1. Clone the repository

git clone https://github.com/awp2016/Libracours

1. Change current directory to the project's folder

cd Libracours

1. Create and activate the virtual environment (Optional)

virtualenv venv
source venv/bin/activate

The virtual environment's name should appear before your username in the terminal prompt if it has been properly activated:(venv) alexandra@Mereu:<current_path>$ instead of alexandra@Mereu:<current_path>$

1. Install requirements

pip install -r requirements.txt

1. Apply migrations

./manage.py migrate

1. Create superuser (Optional)

./manage.py createsuperuser

1. Run development server

./manage.py runserver

⁠Install with Docker

1. Install Docker⁠
2. Run with basic configuration (e.g : /home/alex/work/Libracours)

$ cd <project_directory>
$ docker run -it --rm --name="libracours" \
    --volume=<absolute-path-to-project>:/var/local/libracours \
    -p 8000:8000 cornel/libracours

1. Open website on localhost⁠.

⁠Running interactive console

$ cd <project_directory>
$ docker run -it --rm --name="libracours" \
    --volume=<absolute-path-to-project>:/var/local/libracours \
    -p 8000:8000 --entrypoint=/bin/sh cornel/libracours
# python manage.py migrate
# python manage.py createsuperuser
# python manage.py runserver 0.0.0.0:8000

⁠Guidelines for contributors

Before contributing please make sure you follow these guidelines:

1. Configure your editor to use spaces instead of tabs and set the tab size to 4.
2. Naming convention: use UpperCamelCase for class names, CAPITALIZED_WITH_UNDERSCORES for constants, and lowercase_separated_by_underscores for other names.
3. Use a PEP8 validator to ensure your Python code is compliant with PEP8.