README.md

BecauseOfProg - API

Documentation - License

This is the main API for all the BecauseOfProg. It's an interface to interact with users, posts and to use authentification on other websites.

• 💻 Development
  • Project setup
  • Serve for development
  • Build for production
• 📜 Credits
• 🔐 License

💻 Development

Project setup

First, install Python 3.7 or higher, and install the dependencies like below.

Option 1 : use pipenv (recommended)

Install pipenv using pip and, with it, install the dependencies : pipenv install.

Option 2 : use pip (classic)

Use pip to install the dependencies listed in the requirements.txt file.

Serve for development

If you use Pipenv, enter in your virtual environment : pipenv shell.

Configure the environment variables :

• FLASK_APP : path to main.py
• FLASK_ENV : "development"

Edit the configuration in config-sample.json, and rename this file to config.json.

Run the API using flask run.

Build for production

Install the flup package. Then, edit the api.fcgi file to add path to Python folder, and the socket file that will be generated. Finaly, run the file and connect the socket on your web server !

If you use Pipenv, be careful to precise the path to the virtual environment !

📜 Credits

• Maintainer: Théo Vidal (exybore)

🔐 License

GNU GPL v3. See the license file.