Skip to content

API for the Penn Labs platform built using Django REST framework. Includes accounts engine, club directory, product listings, documentation etc.

License

Notifications You must be signed in to change notification settings

pennlabs/platform

Repository files navigation

Platform

CircleCI Coverage Status

The Labs Platform is the full-stack interface to the ecosystem that facilitates the organization's accounts engine and other cross-product resources.

Installation

  1. Configure environment variables (e.g. .env) containing:
DATABASE_URL=mysql://USER:PASSWORD@HOST:PORT/NAME
SECRET_KEY=secret
DJANGO_SETTINGS_MODULE=Platform.settings.production
SENTRY_URL=https://pub@sentry.example.com/product
  1. Run using docker: docker run -d pennlabs/platform (is this still correct?)

Documentation

Routes are defined in /backend/accounts/urls.py. Account/authorization related scripts are located in accounts/management/commands.

Documentation about individual endpoints is available through the documentation/ route when the Django app is running.

About

API for the Penn Labs platform built using Django REST framework. Includes accounts engine, club directory, product listings, documentation etc.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published