Code Monkey home page Code Monkey logo

ddlc_api's Introduction

The Doki Doki Literature Club API

CI

A REST API for the Doki Doki Literature Club, 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!

Technologies Used

Development

  1. Install Poetry

  2. Create a virtual environment and install dependencies

poetry shell && poetry install
  1. Start the process
ENV=dev uvicorn ddlc:app --reload

Production

  1. Install Docker

  2. Build the image

docker build . -t ultirequiem/ddlc_api
  1. Run the image
docker run -p 8000:8000 -d ultirequiem/ddlc_api

License

This project is licensed under the MIT License.

Team Salvato Intellectual Property Guidelines.

ddlc_api's People

Contributors

imgbotapp avatar ultirequiem avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

ddlc_api's Issues

CORS Problems

Make this works in the browser (This working from Deno/Node.js).

fetch('https://ddlcapi.herokuapp.com')
.then(response => response.json())
.then(console.log)

Feedback: Changes and ideas

Hi there! Very interesting project, and I've looked through some things.

There are a few things that I find quite confusing and an odd choice to add, so I've added some things I believe you could change to improve this API.

First, on the characters.
The JSON returned is
{ "name": "monika", "age": 18, "born_date": "September 22nd", "concept_height": "160 cm", "gender": "Female", "hair_color": "Coral Brown", "eye_color": "Emerald Green", "filename": "monika.chr", "appears": ["Act 1", "Act 2", "Act 3", "Act 4"], "voice_actor": "Jillian Ashcraft" }
It works, but there are a few things I'd change.
First, the name should be Capitalized, so it returns Monika instead of monika.
The age is alright, they're all 18.
born_date, while personal choice of a name, i would rather change that to birthdate, as that is usually most commonly used to refer to the day someone was born.

However, I noticed you added these for the three other characters, and I believe you've been misled, as none of these characters have actual official dates. So for Yuri, Sayori and Natsuki, these should be removed to not mislead people. Only Monika's is known so far.

Concept height is good, but I'd change from string to integer for easier usability

Hair color and eye color is fine imho, but I would suggest using a hex code, but as they are, is fine.

Voice actor is cool.

I noticed your "no character found" error response, which I believe could be swapped out for simply sending back a 400 HTTP Bad Request code instead.

On poems, they're alright, but I noticed you have a translation variable. No idea if you planned to fix this later, but I'd change how these work if thats the case. Maybe add an alternative request handle if you want a specific translation of a poem in a specific language.

The only thing that sticks out to me is the occasion field. Its a bit clunky, but it works. I'd change from string to integer to indicate which day instead.

A suggestion I propose is a font field, where you can specify the Doki's font, if that is useful to someone.

Have a nice day!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.