https://github.com/maael/temtem

🐾 A website to manage your tempedia, quests, encounters, and more!
https://github.com/maael/temtem

temtem

Last synced: 23 days ago
JSON representation

🐾 A website to manage your tempedia, quests, encounters, and more!

• Host: GitHub
• URL: https://github.com/maael/temtem
• Owner: maael
• Created: 2020-01-23T17:30:54.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-28T21:19:10.000Z (10 months ago)
• Last Synced: 2024-05-02T01:24:20.297Z (6 months ago)
• Topics: temtem
• Language: TypeScript
• Homepage: https://tem.tools
• Size: 1.63 MB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Temtem App

- App

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

  - https://tem.tools

- Temtem API

  - https://github.com/maael/temtem-api

  - https://temtem-api.mael.tech

## Features

- List Temtem for sale

- Save Temtem listing

- Track your own tempedia of tamed Temtem, and share your progress with others

- Track your quests in Temtem, including what ones you've picked up and what step you're on

- Track your encounters in Temtem, including an automatic tracker that uses screen capture and OCR

## Docs

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

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

## Install

```sh

[email protected]:maael/temtem.git

cd temtem

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.