From f10b8fa7d5a17a84cb3b7864a44589c0599a0fa0 Mon Sep 17 00:00:00 2001 From: Vikram Singh Date: Thu, 25 Nov 2021 13:12:55 -0500 Subject: [PATCH] initial commit --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index dfb589f6..e2b2ff85 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,7 @@ [![CircleCI](https://circleci.com/gh/pennlabs/platform.svg?style=shield)](https://circleci.com/gh/pennlabs/platform) [![Coverage Status](https://codecov.io/gh/pennlabs/platform/branch/master/graph/badge.svg)](https://codecov.io/gh/pennlabs/platform) -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 +The Labs Platform is the full-stack interface to the ecosystem that facilitates the organization's accounts engine and other cross-product resources. ## Installation @@ -20,10 +16,10 @@ DJANGO_SETTINGS_MODULE=Platform.settings.production SENTRY_URL=https://pub@sentry.example.com/product ``` -1. Run using docker: `docker run -d pennlabs/platform` +1. Run using docker: `docker run -d pennlabs/platform` (is this still correct?) ## 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/`. +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.