Take charge of your reading habits!
Welcome to the GooderReads repository! GooderReads is a powerful full-stack project that allows book lovers to create an account, easily import their bookshelves from Goodreads, and generate insightful reading statistics. With GooderReads, you can gain a deeper understanding of your reading habits through unique visualizations, ratings, and more. This is only version 1 of the project, and we have many exciting updates planned for the future. So, join us on this journey of discovering more about ourselves through the books we love.
Installation To install the application, you will need to do the following:
Clone this repository to your local machine Navigate to the project directory using a terminal or command prompt Run npm install to install the necessary dependencies Create a .env file in the project root and set the following environment variables: MONGO_URI: Your MongodB database key. if you need any assistance to spin up a MongodB cluster, just reach out!
Usage To use the application, follow these steps:
Run npm run dev in the project directory to start the server/frontend Navigate to http://localhost:8080 in your browser Create an account by clicking the "Sign Up" button and following the prompts Login to your account Go to goodreads.com and follow the instructions to export your bookshelf Import your bookshelf from Goodreads by clicking the "Import Bookshelf" button and following the prompts View your reading stats by clicking the "My Stats Page" button
Contributing If you'd like to contribute to the project id love that! please follow these steps:
Fork this repository Create a new branch for your changes Make your changes and commit them with a descriptive message Push your changes to your fork Create a pull request
License This project is licensed under the MIT License. See the LICENSE file for more information.
Acknowledgements This project was made possible thanks to the following resources:
Goodreads PapaParse React-Bar-Chart ...and many more!