Skip to content
hippogriff101Public

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

10 Commits

Folders and files

Repository files navigation

aic-api

A simple Express API to get An Inspector Calls quotes!

I've never used JavaScript like this before so have learnt alot, I've used guides and Claude to help teach me how to build this.

This is also a semi-competionion between me and Jacob to find who could make a AIC API faster, he won, with this Flask API but we both had fun learning how to build this.

How can you get started

Just go to aic.freddieyershon.co.uk!

Here are some scope to get started:

Scope What it does?
/quotes list of quotes
quotes/random random quote
quotes/[character name] all quotes from that character

Features

  • List of quotes (tagged with; character, act, theme and more), stored in data.json

  • API endpoints to list all tags (listed above) stored in the data

  • API endpoints to filter quotes by character /quotes/[name]

  • Main page and documentation with custom css

How to run locally

_(make sure npm is installed, if not look here)

  1. git clone https://github.com/hippogriff101/aic-api && cd aic-api

  2. npm install

  3. node app.js

Head to localhost:3000 and you should be good to go!

How can you help?

If you are up for it, here are a few things you can do to help!

  • Start the repo (it's a nice way to show support)
  • Add more quotes to data.json
  • Add more scopes
  • PR stuff in! I don't really want slop but use AI to help

Credits & Notes

public/openapi.yaml, made by Claude caues idk how to make one

Claude aslso helped with debugging things!

Formatted using Shift + Alt + F (on VSCode for Windows) - thought it best to note

Hackatime catogorised most of my time in app.js as debugging for some reason, this was actual coding time!

Jacob (for his version of the same project, super cool)!!!!!

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages