s1gr1d/animal-crossing-graphql-api

🐸 WIP: GraphQL API for Animal Crossing: New Horizons built with Nest.js

🐸 Description

🚧 THIS REPOSITORY IS STILL A WORK IN PROGRESS 🚧

This is a GraphQL API written with Nest for Animal Crossing: New Horizons. The data is from Data Spreadsheet for Animal Crossing New Horizons. Thanks for providing this ❤

If you want to access the Spreadsheet Data you currently have to create a .env file and set the API_KEY variable from the Google API (How to get one).

I am using the gitmoji emoji guide for commit messages.

⚙ Running the app

Playground with Docs is available at https://animal-crossing-graphql-api.herokuapp.com/graphql or local at http://localhost:8080/graphql

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

🗺 Roadmap

• Villagers

• Critterpedia

  • Insects (in Progress)
  • Fish
  • Fossils

• Art

• ...other categories

• Let others access the data without having to authenticate

  • set up own database

• 🚀 Deploy with Heroku