Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pennlabs/platform
API for the Penn Labs platform built using Django REST framework. Includes accounts engine, club directory, product listings, documentation etc.
https://github.com/pennlabs/platform
django-rest-framework rest-api university-of-pennsylvania
Last synced: about 1 month ago
JSON representation
API for the Penn Labs platform built using Django REST framework. Includes accounts engine, club directory, product listings, documentation etc.
- Host: GitHub
- URL: https://github.com/pennlabs/platform
- Owner: pennlabs
- License: mit
- Created: 2018-08-29T21:46:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-10T17:36:42.000Z (about 2 months ago)
- Last Synced: 2024-11-10T18:31:19.571Z (about 2 months ago)
- Topics: django-rest-framework, rest-api, university-of-pennsylvania
- Language: HTML
- Homepage: https://platform.pennlabs.org
- Size: 3.49 MB
- Stars: 22
- Watchers: 9
- Forks: 2
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Platform
[](https://circleci.com/gh/pennlabs/platform)
[](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
## 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
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_STORAGE_BUCKET_NAME
```
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.
## Installation
You will need to start both the backend and the frontend to do Platform development.
### Backend
Running the backend requires [Python 3](https://www.python.org/downloads/).
To run the server, `cd` to the folder where you cloned `platform`. Then run:
- `cd backend`
Setting up `psycopg2` (this is necessary if you want to be able to modify
dependencies, you can revisit later if not)
- Mac
- `$ brew install postgresql`
- `$ brew install openssl`
- `$ brew unlink openssl && brew link openssl --force`
- `$ echo 'export PATH="/usr/local/opt/openssl@3/bin:$PATH"' >> ~/.zshrc`
- `$ export LDFLAGS="-L/usr/local/opt/openssl@3/lib"`
- `$ export CPPFLAGS="-I/usr/local/opt/openssl@3/include"`
- Windows
- `$ apt-get install gcc python3-dev libpq-dev`
Now, you can run
- `$ pipenv install` to install Python dependencies. This may take a few
minutes. Optionally include the `--dev` argument if you are installing locally
for development. If you skipped installing `psycopg2` earlier, you might see
an error with locking -- this is expected!
- `$ pipenv shell`
- `$ ./manage.py migrate` OR `$ python3 manage.py migrate`
- `$ ./manage.py populate_users` OR `$ python3 manage.py populate_users` (in development,
to populate the database with dummy data)
- `$ ./manage.py runserver` OR `$ python3 manage.py runserver`
### Frontend
Running the frontend requires [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/getting-started/install).
1. Enter the `frontend` directory with a **new terminal window**. Don't kill your backend server!
2. Install dependencies using `yarn install` in the project directory.
3. Run application using `yarn dev`.
4. Access application at [http://localhost:3000](http://localhost:3000).
### Development
Click `Login` to log in as a test user. The `./manage.py populate_users` command creates a test user for you with username `bfranklin` and password `test`. Go to `/api/admin` to login to this account.