https://github.com/royanger/fairtask
A project created helping out a team from Co.Lab who lost their developers. Fairtask helps household with tasks and chores through gamification and rewards
https://github.com/royanger/fairtask
nextjs postgresql prisma react-query reactjs tailwindcss trpc
Last synced: 3 months ago
JSON representation
A project created helping out a team from Co.Lab who lost their developers. Fairtask helps household with tasks and chores through gamification and rewards
- Host: GitHub
- URL: https://github.com/royanger/fairtask
- Owner: royanger
- License: mit
- Created: 2022-07-20T02:31:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-31T04:37:55.000Z (almost 4 years ago)
- Last Synced: 2024-04-20T13:01:08.246Z (about 2 years ago)
- Topics: nextjs, postgresql, prisma, react-query, reactjs, tailwindcss, trpc
- Language: TypeScript
- Homepage: https://fairtask.royanger.app
- Size: 1.23 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fair Task App
## Configuring
Please see the `.env-sample` file for the variables required. During development and testing the DB was hosted on [Railway](https://railway.app) and it works great. Any Postgres host will work. You could use other DBs, though that could require edits to the schema and possibly some of the queries and mutations.
Of note, the app uses the email settings as a string. The format is `smtp://:@:`
## Development
### Migration or Push
You will need to run a database migration or push. The exact method may depend on the DB you use and can depend on preference. Please see the [migrate](https://www.prisma.io/docs/concepts/components/prisma-migrate) and [push](https://www.prisma.io/docs/reference/api-reference/command-reference#db-push) documentation for details.
This will need to run after any database schema changes.
### Prisma Client
You may also need to run `npx prisma generate` to create the Prisma client and update type defs.
### Running
`npm run dev` will run the Next app, which includes the serverless routes for the API.
## Deployment
You will want to setup a production database, but otherwise transfer all environement variables to your host. The application runs flawlessly on [Netlify](https://www.netlify.com/) and [Vercel](https://vercel.com/).
You will need to add `Migration/Push` and `Generate` commands to your build options as required.