https://github.com/sparcs-kaist/new-ara-api
Restful API for Ara, KAIST's official community service
https://github.com/sparcs-kaist/new-ara-api
ara drf kaist sparcs
Last synced: about 2 months ago
JSON representation
Restful API for Ara, KAIST's official community service
- Host: GitHub
- URL: https://github.com/sparcs-kaist/new-ara-api
- Owner: sparcs-kaist
- License: mit
- Created: 2017-09-13T07:30:54.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2026-02-19T18:14:59.000Z (5 months ago)
- Last Synced: 2026-02-19T21:37:44.868Z (5 months ago)
- Topics: ara, drf, kaist, sparcs
- Language: Python
- Homepage: http://newara.sparcs.org/
- Size: 2.45 MB
- Stars: 21
- Watchers: 9
- Forks: 2
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ara API
Restful API for Ara, KAIST's official community service
![GitHub Pipenv locked Python version (master)][badge/python-version]
[![Code style: black][badge/black]][repo/black]
[![Imports: isort][badge/isort]][isort]
[![pre-commit][badge/pre-commit]][repo/pre-commit]
[![Conventional Commits][badge/conventional-commits]][conventional-commits]
## Project Setup
Use pipenv to install packages. (e.g., `pipenv install `)
```bash
pipenv --python 3.11 # Use python 3.11
pipenv shell # Activate virtual environment
pipenv install --dev # Install packages (`--dev` flag for development)
# Run `pre-commit` automatically on `git commit`
pre-commit install
pre-commit install --hook-type commit-msg
```
## How to Run
```bash
docker compose -f docker-compose.local.yml up -d
pipenv shell
make run
```
## URLs
- Base URL: `/api`
- Admin page: `/api/admin/`
- API documentations:
- `/api/schema/swagger/`
- `/api/schema/redoc/`
## How to Contribute
1. Follow [Conventional Commits][conventional-commits] for writing commit messages.
2. Use type hints strictly. (Check [PEP 484][pep-484].)
[badge/python-version]: https://img.shields.io/github/pipenv/locked/python-version/sparcs-kaist/new-ara-api/master
[badge/black]: https://img.shields.io/badge/code%20style-black-000000
[badge/isort]: https://img.shields.io/badge/%20imports-isort-%231674b1?labelColor=ef8336
[badge/pre-commit]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
[badge/conventional-commits]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white
[isort]: https://pycqa.github.io/isort
[conventional-commits]: https://conventionalcommits.org
[pep-484]: https://peps.python.org/pep-0484/
[repo/black]: https://github.com/psf/black
[repo/pre-commit]: https://github.com/pre-commit/pre-commit