This is the repository of Forum Organisation's official website.

These instructions will get help get your own copy of the project running on your local machine for development and testing purposes.

To get your development environment running, you need:

• python 3
• bower
• mongodb

To install the necessary dependencies:

git clone https://github.com/ForumOrganisation/forumorg.git
cd forumorg && pip install -r requirements.txt
bower install

To start the project, you need to provide the following environment variables:

export MONGODB_URI="mongodb://host:port/dbname" # Required: local running mongodb instance
export BUCKET_NAME="bucket_name" # Required: S3 bucket name
export DEBUG=True # Optional: Nice for debugging
export SENDGRID_API_KEY="sendgrid_key" # Optional: for emailing events

python runserver.py

We use Heroku for Cloud hosting and Continuous Integration, using this continuous delivery workflow:

• A developer creates a pull request to make a change to the codebase.
• Heroku automatically creates a review app for the pull request, allowing developers to test the change.
• When the change is ready, it’s merged into the codebase’s master branch.
• The master branch is automatically deployed to staging for further testing.
• When it’s ready, the staging app is promoted to production, where the change is available to end users of the app.

The app is localized using:

• Flask-Babel: used to indicate which strings needs to be translated (surrounded with _('STRING'))
• PhraseApp: provides a nice UI to translate the strings

You can get familiar with the process by following this tutorial.

Contributions are very welcome! If you find a bug or some improvements, feel free to raise an issue and send a PR! Please see the CONTRIBUTING file for more information on how to contribute.

• Mehdi BAHA - mehdibaha
• Juliette BRICOUT - jbricout
• Mohammed MEGZARI - momeg
• Hatim BINANI - TheHeisenberg
• Ismail Zemmouri - IsmailZemmouri

(Note to contributors: Add yourself!)

This project is licensed under the MIT License - see the LICENSE file for details