https://github.com/pennlabs/platform-dev

Development version of Platform for testing with user accounts
https://github.com/pennlabs/platform-dev

Last synced: about 6 hours ago
JSON representation

Development version of Platform for testing with user accounts

• Host: GitHub
• URL: https://github.com/pennlabs/platform-dev
• Owner: pennlabs
• License: mit
• Created: 2020-02-20T05:59:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T07:44:54.000Z (almost 2 years ago)
• Last Synced: 2024-04-08T16:04:54.386Z (7 months ago)
• Language: Python
• Size: 127 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Platform

[![CircleCI](https://circleci.com/gh/pennlabs/platform-dev.svg?style=shield)](https://circleci.com/gh/pennlabs/platform-dev)

[![Coverage Status](https://codecov.io/gh/pennlabs/platform-dev/branch/master/graph/badge.svg)](https://codecov.io/gh/pennlabs/platform-dev)

The  Labs Platform  is the back-end interface to the ecosystem that facilitates the organization's:

1. Accounts Engine

2. Cross-Product Resources

3. Organizational Information

## Installation

0. Configure environment variables (e.g. `.env`) containing:

```bash

DATABASE_URL=mysql://USER:PASSWORD@HOST:PORT/NAME

SECRET_KEY=secret

DJANGO_SETTINGS_MODULE=Platform.settings.production

SENTRY_URL=https://[email protected]/product

```

1. Run using docker: `docker run -d pennlabs/platform`

## Documentation

Routes are defined in `/pennlabs/urls.py` and subsequent app folders in the form of `*/urls.py`. Account/authorization related scripts are located in `accounts/` and Penn Labs related scripts are located in `org/`.

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