From eef5a39504dbabfeef2589b87de8d2f281d3deaa Mon Sep 17 00:00:00 2001 From: Nishant | Js <69218488+NishantCoder108@users.noreply.github.com> Date: Mon, 4 Mar 2024 12:27:06 +0530 Subject: [PATCH] Update README.md Update readme --- README.md | 79 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 56 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 2e5c0a8..30868e7 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,67 @@ -Live on :👉👉👉 [devlib.](https://devlib108.vercel.app/) +# AI-Based Books Library + +A web application for book recommendations powered by AI. Users can ask for book recommendations based on their interests and preferences, and the app provides personalized suggestions. Users can also download the recommended books. + +## Live Link + +[devlib.](https://devlib108.vercel.app/) + +## Technologies Used + +- **Frontend**: React.js, TypeScript, NextUi, Tailwind CSS +- **State Management**: Redux Toolkit +- **Authentication**: Firebase Authentication +- **Design**: Figma for UI/UX design +- **Deployment**: Vercel +- **AI Integration**: OpenAI for book recommendations -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +## Features -Currently, two official plugins are available: +- **AI Book Recommendations**: Get personalized book recommendations based on your preferences. +- **Download Books**: Download recommended books directly from the app. +- **User Authentication**: Securely authenticate users using Firebase Authentication. +- **Responsive Design**: Fully responsive design for a seamless experience on all devices. -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +## Getting Started -## Expanding the ESLint configuration +To get a local copy up and running, follow these simple steps: -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: +1. Clone the repo + ```sh + git clone https://github.com/NishantCoder108/devlib.git + ``` +2. Install NPM packages + ```sh + npm install + ``` +3. Start the development server + ```sh + npm run dev + ``` + +## Contributing + +Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +