https://github.com/s1gr1d/animal-crossing-graphql-api

🐸 WIP: GraphQL API for Animal Crossing: New Horizons built with Nest.js
https://github.com/s1gr1d/animal-crossing-graphql-api

animal-crossing animal-crossing-new-horizons nestjs

Last synced: 14 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/s1gr1d/animal-crossing-graphql-api
• Owner: s1gr1d
• Created: 2020-05-23T22:30:17.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-08T03:16:35.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T20:30:59.723Z (3 months ago)
• Topics: animal-crossing, animal-crossing-new-horizons, nestjs
• Language: TypeScript
• Homepage: https://animal-crossing-graphql-api.herokuapp.com/graphql
• Size: 458 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
##  🐸 Description 

:construction: THIS REPOSITORY IS STILL A WORK IN PROGRESS :construction:

This is a GraphQL API written with [Nest](https://github.com/nestjs/nest) for **Animal Crossing: New Horizons**. The data is from [Data Spreadsheet for Animal Crossing New Horizons](https://docs.google.com/spreadsheets/d/13d_LAJPlxMa_DubPTuirkIV4DERBMXbrWQsmSh8ReK4/).  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](https://cloud.google.com/docs/authentication/api-keys)).

I am using the [gitmoji](https://gitmoji.carloscuesta.me/) 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

```bash

# development

$ npm run start

# watch mode

$ npm run start:dev

# production mode

$ npm run start:prod

```

## 🗺 Roadmap

- [x] Villagers

- [ ] Critterpedia

  - [ ] Insects ***(in Progress)***

  - [ ] Fish

  - [ ] Fossils

- [ ] Art

- [ ] ...other categories

- [ ] Let others access the data without having to authenticate

  - [ ] set up own database

- [x] **🚀 Deploy with Heroku**