diff --git a/README.md b/README.md index c403366..e0f1d08 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ +# TODO List App Challenge 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). -## Getting Started +## Run App -First, run the development server: +First, create `.env` file base on `.env.example`: ```bash npm run dev @@ -13,24 +14,40 @@ pnpm dev # or bun dev ``` +Open http://localhost:3000 with your browser to see the result. -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## Features +- Login/Sign-up +- Create Task +- Edit Task +- Delete Task +- Mark as Completed -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +## Stacks +- Frontend -> [Next.js](https://nextjs.org/) +- Auth -> [Supabase](https://supabase.com/) +- Database -> [Supabase](https://supabase.com/) +- UI -> [TailwindCSS](https://tailwindcss.com/) + [Radix UI](https://www.radix-ui.com/) +- State Management -> [Zustand](https://github.com/pmndrs/zustand) -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +## Screenshots +### Home page +![alt text](./screenshots/homepage.png) -## Learn More +### Sign in page +![alt text](./screenshots/sign-in.png) -To learn more about Next.js, take a look at the following resources: +### Default View +![alt text](./screenshots/dashboard-default.png) -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +### TBD +![alt text](./screenshots/tbd-task.png) -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +### Completed +![alt text](./screenshots/completed-task.png) -## Deploy on Vercel +### Update Task +![alt text](./screenshots/update-task.png) -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. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +### Updated Task +![alt text](./screenshots/updated-task.png) diff --git a/screenshots/completed-task.png b/screenshots/completed-task.png new file mode 100644 index 0000000..2744f03 Binary files /dev/null and b/screenshots/completed-task.png differ diff --git a/screenshots/dashboard-default.png b/screenshots/dashboard-default.png new file mode 100644 index 0000000..bc4f943 Binary files /dev/null and b/screenshots/dashboard-default.png differ diff --git a/screenshots/homepage.png b/screenshots/homepage.png new file mode 100644 index 0000000..a23ce6d Binary files /dev/null and b/screenshots/homepage.png differ diff --git a/screenshots/sign-in.png b/screenshots/sign-in.png new file mode 100644 index 0000000..9f3dfcb Binary files /dev/null and b/screenshots/sign-in.png differ diff --git a/screenshots/tbd-task.png b/screenshots/tbd-task.png new file mode 100644 index 0000000..def9207 Binary files /dev/null and b/screenshots/tbd-task.png differ diff --git a/screenshots/update-task.png b/screenshots/update-task.png new file mode 100644 index 0000000..fa4bb49 Binary files /dev/null and b/screenshots/update-task.png differ diff --git a/screenshots/updated-task.png b/screenshots/updated-task.png new file mode 100644 index 0000000..08961aa Binary files /dev/null and b/screenshots/updated-task.png differ