From 99fa85ed5b0813aa27c65129e2e002c549698093 Mon Sep 17 00:00:00 2001 From: Joel Cofie Date: Fri, 10 Nov 2023 20:50:05 +0000 Subject: [PATCH] update readme --- README.md | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c403366..748219e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -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 -First, run the development server: +To run the development server: ```bash npm run dev @@ -16,21 +14,14 @@ bun dev Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More +The following features are available within the application -To learn more about Next.js, take a look at the following resources: +# Learn More -- [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. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +- Users are able to see all dashboards returned by the API endpoint when the app loads +- When clicking on the filter items, the dashboard is updated accordingly and the data persists across reloads, forward and back navigation flows +- Starred dashboards are persisted across reloads ## Deploy on Vercel -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. +The app is deployed to vercel at: [https://dhis2-test-dashboard.vercel.app/](https://dhis2-test-dashboard.vercel.app/)