diff --git a/README.md b/README.md index 965a122..f360911 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,55 @@ -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). +# Kanban task management web app solution -## Getting Started +This is a solution to the [Kanban task management web app challenge on Frontend Mentor](https://www.frontendmentor.io/challenges/kanban-task-management-web-app-wgQLt-HlbB). Frontend Mentor challenges help you improve your coding skills by building realistic projects. -First, run the development server: +## Table of contents -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -``` +- [Overview](#overview) + - [The challenge](#the-challenge) + - [Screenshot](#screenshot) + - [Links](#links) + - [Built with](#built-with) +- [Author](#author) -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## Overview -You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. +### The challenge -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. +Users should be able to: -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. +- View the optimal layout for the app depending on their device's screen size +- See hover states for all interactive elements on the page +- Create, read, update, and delete boards and tasks +- Receive form validations when trying to create/edit boards and tasks +- Mark subtasks as complete and move tasks between columns +- Hide/show the board sidebar +- Toggle the theme between light/dark modes +- **Bonus**: Allow users to drag and drop tasks to change their status and re-order them in a column +- **Bonus**: Keep track of any changes, even after refreshing the browser (`localStorage` could be used for this if you're not building out a full-stack app) +- **Bonus**: Build this project as a full-stack application -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +### Screenshot -## Learn More +![](./screenshots/desktop.png) -To learn more about Next.js, take a look at the following resources: +### Links -- [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. +- Live Site URL: [Kanban webapp](https://kanban-sasanqc.vercel.app/) -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +### Built with -## Deploy on Vercel +- Typescript +- [Next.js](https://nextjs.org/) - React framework +- [React](https://reactjs.org/) - JS library +- MongoDB and mongoose library to persist data on server side. +- Tailwind CSS for styling +- Redux toolkit for UI state management +- react-query for remote state management +- react-beautiful-dnd for drag and drop -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. +## Author -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +- Github - [@sasanqc](https://github.com/sasanqc/) +- Frontend Mentor - [@sasanqc](https://www.frontendmentor.io/profile/sasanqc) +- Twitter - [@sasanqc](https://www.twitter.com/sasanqc) +- Linkedin - [@sasanqc](https://www.linkedin.com/in/sasanqc) diff --git a/screenshots/desktop.png b/screenshots/desktop.png new file mode 100644 index 0000000..9d2e786 Binary files /dev/null and b/screenshots/desktop.png differ