Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ultirequiem/ddlc_api
📚 The Doki Doki Literature Club API
https://github.com/ultirequiem/ddlc_api
api ddlc doki-doki-literature-club fastapi natsuki python restful-api
Last synced: 3 months ago
JSON representation
📚 The Doki Doki Literature Club API
- Host: GitHub
- URL: https://github.com/ultirequiem/ddlc_api
- Owner: UltiRequiem
- License: mit
- Created: 2021-11-05T19:39:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-28T15:47:51.000Z (4 months ago)
- Last Synced: 2024-10-24T04:50:07.282Z (4 months ago)
- Topics: api, ddlc, doki-doki-literature-club, fastapi, natsuki, python, restful-api
- Language: Python
- Homepage: https://ddlcapi.herokuapp.com/docs
- Size: 1.46 MB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# The Doki Doki Literature Club API
[](https://github.com/UltiRequiem/ddlc_api/actions/workflows/ci.yml)
A REST API for the [Doki Doki Literature Club](https://ddlc.moe), The #1
Psychological Horror Experience.
## Documentation
Check the autogenerated interactive documentation generated by Swagger UI:
> https://ddlcapi.herokuapp.com/docs
## Projects Using this API
If you are using this API in your project make a pull request adding it here!
- [Doki Doki Literature Club Members](https://ultirequiem.github.io/ddlc-club-members) -
Source
[UltiRequiem/ddlc-club-members](https://github.com/UltiRequiem/ddlc-club-members)
## Technologies Used
- [FastAPI](https://fastapi.tiangolo.com)
- [MongoDB](https://mongodb.com)
- [Docker](https://docker.com)
- [Python Poetry](https://python-poetry.org)
## Development
1. Install [Poetry](https://python-poetry.org)
2. Create a virtual environment and install dependencies
```sh
poetry shell && poetry install
```
3. Start the process
```sh
ENV=dev uvicorn ddlc:app --reload
```
## Production
1. Install [Docker](https://docs.docker.com/get-docker)
2. Build the image
```sh
docker build . -t ultirequiem/ddlc_api
```
3. Run the image
```sh
docker run -p 8000:8000 -d ultirequiem/ddlc_api
```
## License
This project is licensed under the [MIT License](./license).
[Team Salvato Intellectual Property Guidelines](http://teamsalvato.com/ip-guidelines).