Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.74 KB

README.md

File metadata and controls

71 lines (51 loc) · 2.74 KB

Nook App

Features

  • 🌹 Track your flower colours + cross breeding chart
  • 🐟 Track fish you've caught
  • 🐛 Track bugs you've caught
  • 🎨 Show off and find custom designs
  • 📆 A daily checklist
  • 🌋 Track fossils you've found
  • 📝 Track what DIY recipes you've found
  • 🎸 Track what K.K Slider Songs you've got
  • 💸 Find items and easily see their sell price

Docs

Install

[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 against project.
prettier Runs prettier against project, writing corrections.
prettier:check Runs 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.