https://github.com/davidcelis/nook_stop_api

🍃 Welcome to Nook Stop, a multimedia terminal from Nook Inc. This toy app is an example of how to build a GraphQL API in Ruby, powered by data from Animal Crossing: New Horizons.
https://github.com/davidcelis/nook_stop_api

animal-crossing animal-crossing-new-horizons api fun graphql

Last synced: about 1 month ago
JSON representation

🍃 Welcome to Nook Stop, a multimedia terminal from Nook Inc. This toy app is an example of how to build a GraphQL API in Ruby, powered by data from Animal Crossing: New Horizons.

• Host: GitHub
• URL: https://github.com/davidcelis/nook_stop_api
• Owner: davidcelis
• Created: 2022-06-10T19:06:22.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-09T01:22:49.000Z (about 2 years ago)
• Last Synced: 2025-03-18T18:57:58.513Z (about 1 month ago)
• Topics: animal-crossing, animal-crossing-new-horizons, api, fun, graphql
• Language: HTML
• Homepage: https://acnh.apps.davidcel.is/
• Size: 3.63 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Nook Stop API

![Welcome to Nook Stop, a multimedia terminal from Nook Inc.](/public/assets/images/nook-stop-terminal.png)

This application powers the API for our main Nook Stop terminal, located in the Resident Service building of the island.

## Getting Started

This application serves as a fun demonstration of how to build an API using GraphQL (lovingly referred to as GiraffeQL throughout the Nook Stop API docs). If you'd like to run it yourself, there are just a couple prerequisites:

* Ruby (3.2.1)

* PostgreSQL (14.3)

Assuming you have these installed, you can clone this repository and run `bin/setup`. This should create the database and seed it with all of the data from Animal Crossing: New Horizons! Then, just run `bin/rails server` and visit http://localhost:3000/ in your browser to see the generated docs site, or http://localhost:3000/graphiql to play around with queries in the interactive GraphiQL environment.