/backend

Open Source (MIT) Backend for Opus Team

Primary LanguagePython

Opus Team API

Website Status GitHub license Generic badge

About

This is the Opus REST API which serves the Opus Frontend. It currently contains documentation and endpoints for users, teams, requests, events, announcements, JWT, Django Admin.

Available at https://api.opusteam.us.

Dependencies

  • Python v3.9
  • Pipenv 2020.11.5
  • PostgreSQL 13.2
  • All Python Modules under ./Pipfile.lock

Contributing

Setup

  • Install Python
  • Install Pipenv pip install pipenv
  • Install PostgreSQL for your system here
  • Alternatively you can install it on MacOS using Homebrew:
brew install psql
  • On Debian/Ubuntu use apt-get
sudo apt-get install psql
  • Using Pipenv install the other dependencies
pipenv install
pipenv install --dev
  • For MacOS users, install psycopg2-binary
pip install psycopg-2 binary

Installing Additional Packages

  • Start the Python virtual environment and use pipenv for package installations
pipenv shell
pipenv install <package-name>
  • Clone the repository git clone git@github.com:Instaline/Instaline-Markdown.git
  • Activate the virtual environment pipenv shell
  • Install Dependencies pipenv install
  • Run the CLI python3 parse.py

License

MIT.