From 0720dadfeae34dbfd49760132f8f6fad305c0d79 Mon Sep 17 00:00:00 2001 From: Bartosz Art Date: Tue, 12 Mar 2024 02:29:13 +0100 Subject: [PATCH] Updated README.md file --- README.md | 43 ++++++++++++++----------------------------- 1 file changed, 14 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 5ce4a7c..e90898e 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,21 @@ -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). +# Price checker -## Getting Started +> This app can be previewed on [https://price-checker-nine.vercel.app/](https://price-checker-nine.vercel.app/) -First, run the development server: +## Project scope -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +This app is a result of my frustration with repeatedly checking the price of items I'm interested in purchasing. -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## Experience -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +In this project, I developed my skills in Next.js 13, TypeScript, PostgreSQL, CI/CD (GitHub Workflows) and Git. -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +## Requirements -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [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! - -## 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. +- [x] Scraping vendors websites for current prices, quantity and availability of items +- [x] Store data in database +- [x] Display data as a chart +- [x] Filter chart data +- [ ] User accouts +- [ ] Managing item tracking +- [ ] Email notifications