docs: update readme with to do list
This commit is contained in:
62
README.md
62
README.md
@@ -1,36 +1,56 @@
|
|||||||
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
|
# Water utility portal
|
||||||
|
|
||||||
## Getting Started
|
## To do
|
||||||
|
|
||||||
First, run the development server:
|
- [ ] Add database schema
|
||||||
|
- [ ] Add user authentication
|
||||||
|
- [ ] Add user roles
|
||||||
|
- [ ] Add user permissions
|
||||||
|
- [ ] Add user profile
|
||||||
|
- [ ] Add user notifications and emails
|
||||||
|
- [ ] Add user invoices
|
||||||
|
- [ ] Add cron jobs to import data
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
Install vercel cli
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
yarn add -g vercel@latest
|
||||||
# or
|
|
||||||
yarn dev
|
|
||||||
# or
|
|
||||||
pnpm dev
|
|
||||||
# or
|
|
||||||
bun dev
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
Link to vercel
|
||||||
|
|
||||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
```bash
|
||||||
|
yarn vercel:link
|
||||||
|
```
|
||||||
|
|
||||||
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
|
Pull env variables from vercel
|
||||||
|
|
||||||
## Learn More
|
```bash
|
||||||
|
yarn vercel:env
|
||||||
|
```
|
||||||
|
|
||||||
To learn more about Next.js, take a look at the following resources:
|
Push Prisma schema to vercel
|
||||||
|
|
||||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
```bash
|
||||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
yarn db:push
|
||||||
|
```
|
||||||
|
|
||||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
|
Generate Prisma client
|
||||||
|
|
||||||
## Deploy on Vercel
|
```bash
|
||||||
|
yarn prisma:generate
|
||||||
|
```
|
||||||
|
|
||||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
Reset Prisma database
|
||||||
|
|
||||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
|
```bash
|
||||||
|
yarn db:reset
|
||||||
|
```
|
||||||
|
|
||||||
|
Run on Docker
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker-compose up --build
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user