SiteWebGeniALE

Production:

Development:

The new website of GeniALE. 🍻 This repository contains the CMS and the additional modules.

Table of content

• SiteWebGeniALE
• Table of content
• Getting Started
  • Prerequisites
  • Installing
  • Branching model
• Deployment
  • Production deployment
• Plugins
• Documentation
• Authors
• Acknowledgments
• Licenses
  • Owl carousel

Getting Started

Clone this repository

git clone [email protected]:GeniALE/SiteWebGeniALE.git

Prerequisites

A Slack account to join our chat platform. Be in the Trello Website Board, where we have all the tasks there.

Otherwise, here are the prerequisites:

• Python 3.5
• PostgreSQL 10 and later

Installing

If you wish to use docker, see the Docker documentation.

If you wish to use Pycharm, see the Pycharm documentation.

Basic installation

Before starting, you need to create a database for the website. You can either use the create a database from the terminal or with a GUI such as PGAdmin

Clone the Github repository

  git clone https://github.com/GeniALE/SiteWebGeniALE.git

Create an .env file with your configurations

cd SiteWebGeniALE
cp .env.example .env

Note: You might want to change the values according to your environment configurations.

Create your virtualenv

virtualenv -p python3 venv

Each time you want to work on your project, you need to activate your environment:

On Unix like OS:

source env/bin/activate

On Windows:

env\Scripts\activate

Install dependencies, migrations and create super user

pip3 install -r requirements.txt
python3 manage.py migrate
python3 manage.py createsuperuser

You can finally start the server with:

python3 manage.py runserver 0.0.0.0

The website should be running at http://localhost:8080

Branching model

For this project, we are using a branching model that focus on continuous delivery.

Basically, you have those type of branches :

• master : Trunk or latest branch
• feature : New feature development based on master
• fix : A fix for something in master.

Feature workflow

• Create your feature branch from the master with a feature/ prefix.
• Do your work
• Rebase master into your branch
• Review and test
• Create pull request
• Set the reviewers for your pull request (you must have at least ONE approval to merge)
• Assign the pull request to the person in charge of merging (it can be yourself)
• Assign your Trello card to the same person you assigned the PR
• Merge the branch when you have your approvals

Fix workflow

When we find a flaw, we have to respond quickly to fix that bug.

The workflow is pretty much the same.

The only difference is the branch prefix: fix/.

Deployment

At the moment, the website is deployed at: http://geniale-cms.herokuapp.com/

Production deployment

1. Pull the repository

2. Install the dependencies:

   pip install -r requirements.txt

3. Create the environment configuration: cp .env.example .env

4. Modify the environment configuration and set the database credentials.

5. To use Orchester, you need to create a .orchester.json configuration file with the proper credentials. For more details, refers to that documentation: https://github.com/popojargo/orchester

6. Start the server

   python manage.py migrate && python manage.py runserver 0.0.0.0:80

Plugins

• Team module
• Beer carousel
• Sponsors Module
• Orchester integration module

Documentation

• Backups
• Docker
• Pycharm
• Translations
• Orchester

Authors

• Gabriel Bergeron
• William Cantin
• Mathieu Chan Yee Choy
• Alexis Côté
• Alexandre Desgagné

See also the list of contributors who participated in this project.

Acknowledgments

• Club Cedille 🌐

Licenses

Owl carousel

The code and the documentation are released under the MIT License.