Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbchoa/flexin
💪 A PWA for daily tracking and progress of a 30-day pushup routine.
https://github.com/mbchoa/flexin
nextjs tailwindcss typescript
Last synced: 2 days ago
JSON representation
💪 A PWA for daily tracking and progress of a 30-day pushup routine.
- Host: GitHub
- URL: https://github.com/mbchoa/flexin
- Owner: mbchoa
- Created: 2022-03-05T02:07:38.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-03T15:45:23.000Z (over 1 year ago)
- Last Synced: 2024-10-28T08:27:36.038Z (about 2 months ago)
- Topics: nextjs, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://flexin.one
- Size: 1.04 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 💪 flexin [](http://commitizen.github.io/cz-cli/)
A PWA for daily tracking and progress of a 30-day pushup routine.
## Getting Started
### **.env**
Copy the `.env.example` file to an `.env` file at the root of the directory.
### **Services**
First, let's spin up containers for a Postgres DB and a fake SMTP server. The SMTP server is used for the passwordless login via email:
```bash
docker-compose up -d
```
Let's also open up a new browser tab at http://localhost:3080. This is the SMTP email client interface we'll use to receive emails outgoing from the application.
### **Prisma**
We'll need to generate the Prisma client so let's run a migration using the initial migration file to setup our Postgres DB.
```bash
npx prisma migrate dev
```
Running this command will apply the initial migration to setup the database as well as generate the Prisma client that's used in the application.
### **Next.js**
Next, let's spin up our Next.js app
```bash
npm run dev
# or
yarn dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser.
### **Authenticating**
This app has an authentication wall and so you will be directed to the signin page and asked for an email. Enter the email and submit, you'll be navigated to a verification page asking for the one time code. Navigate back to the SMTP email client tab and open the email. The email will contain the code you need to enter on the verification page.
## Tech Stack
- Next.js: React framework
- NextAuth.js: authentication for Next.js
- Prisma: database ORM
- Postgres: our database
- Nodemailer: email client
- Tailwind: CSS framework
- TypeScript: typing system
- ESLint: JavaScript linter
- Prettier: code formatter
- Husky: git hooks for pre-commit linting, testing
- Commitizen: CLI for enforcing commit message conventions