https://github.com/maael/nook

🐘 A website to track your collections and share custom designs in Animal Crossing: New Horizons!
https://github.com/maael/nook

acnh animal-crossing new-horizons nextjs

Last synced: about 1 month ago
JSON representation

🐘 A website to track your collections and share custom designs in Animal Crossing: New Horizons!

• Host: GitHub
• URL: https://github.com/maael/nook
• Owner: maael
• Created: 2020-04-01T08:35:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-27T23:32:05.000Z (11 months ago)
• Last Synced: 2024-11-01T22:50:37.902Z (about 2 months ago)
• Topics: acnh, animal-crossing, new-horizons, nextjs
• Language: TypeScript
• Homepage: https://nook.services
• Size: 29.1 MB
• Stars: 15
• Watchers: 2
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Nook App

- App

  - https://github.com/maael/nook

  - https://nook.services

## Features

- :rose: Track your flower colours + cross breeding chart

- :fish: Track fish you've caught

- :bug: Track bugs you've caught

- :art: Show off and find custom designs

- :calendar: A daily checklist

- :volcano: Track fossils you've found

- :memo: Track what DIY recipes you've found

- :guitar: Track what K.K Slider Songs you've got

- :money_with_wings: Find items and easily see their sell price

## Docs

- [Auth](./docs/AUTH.md)

- [Database](./docs/DATABASE.md)

## Install

```sh

[email protected]:maael/nook.git

cd nook

yarn

```

I used `[email protected]` to develop it.

## NPM Scripts

| Script           | Description                                                                                             |

| ---------------- | ------------------------------------------------------------------------------------------------------- |

| `dev`            | Starts the local development server on `http://localhost:3000`, or whatever `PORT` is specified in env. |

| `build`          | Builds server.                                                                                          |

| `start`          | Started built server.                                                                                   |

| `lint`           | Runs [tslint](https://www.npmjs.com/package/tslint) against project.                                    |

| `prettier`       | Runs [prettier](https://www.npmjs.com/package/prettier) against project, writing corrections.           |

| `prettier:check` | Runs [prettier](https://www.npmjs.com/package/prettier) against project, used by CI to check project.   |

| `test`           | ⚠️ TODO ⚠️                                                                                              |

## Config

| Environment Variable  | Description                 |

| --------------------- | --------------------------- |

| `REDDIT_OAUTH_ID`     | OAuth ID for Reddit app     |

| `REDDIT_OAUTH_SECRET` | OAuth Secret for Reddit app |

| `JWT_SECRET`          | Secret to sign JWT with     |

## API Endpoints

| URL                          | What                                         |

| ---------------------------- | -------------------------------------------- |

| `/api/login`                 | Redirects to Reddit to start OAuth flow      |

| `/api/oauth/redirect/reddit` | Reddit redirects here to continue OAuth flow |

## Contributing

- Make sure `prettier` has been run, it should do it as a pre-commit hook thanks to `husky` and `pretty-quick`.

Also fair warning, I made this quick, so while it is Typescript, it's super loose with anys all over the place.

## Todo

- [ ] The rest of the owl.