"What others read and say?" - ShelfShare

📚️ This is the 🌝 social cataloging website for readers 🧐 and book 📖 recommendations inspired by goodreads.

User Stories:

• As a user, I want to search for books by title, author, or genre, so I can discover new reading material.
• As a logged-in user, I can view individual books to see a summary of the book as well as other user reviews + ratings.
• As a logged-in user, I can leave reviews + ratings for books.
• As a logged-in user, I can leave reviews + ratings for books.
• As a logged-in user, I can add books to my list to view them later.
• As a logged-out user, I can want to see books that I could discover + information about the website so that I can learn more about what the site offers.
• As a logged-in user, I can view a dropdown menu to see my profile and access books I’ve read + their respective reviews, as well as a logged-out.

Getting Started

Installation

1. Clone repository

git clone https://github.com/chingu-voyages/v49-tier3-team-29.git

2. Install npm packages both in "client" and "backend" directory.

npm install

3. Create .env file both in "client" and "backend" directory.

client > .env

# Demo User Credentials
VITE_DEMO_USERNAME=demo_user
VITE_DEMO_PASSWORD=demo4929
VITE_BACKENDURL=http://localhost:5001 👈️ The backend URL varies based on your local environment.

backend > .env

PORT=5001
DB_URI='mongodb://localhost:27017/your-database-name'
BREVO_USERID='your-brevo-user-id' 👈️ This variable is required *only* for password reset function. Our team created and used one Breavo account under free-of-charge pricing tier.
BREVO_PASS='your-brevo-password' 👈️ You can create your account and go to https://app.brevo.com/settings/keys/smtp to get your credentials.
JWT_SECRET='your-jwt'
DEMOUSER_PASSWORD=demo4929 👈️ Demo user password should be identical with .env in client.

4. Run app on client terminal and on backend terminal.

npm run dev

🚀 Technologies used

• Responsive Design
• Local Storage

Our Team

• Arieonna Hearn: GitHub
• Bia: GitHub
• Alex Hunt: GitHub / LinkedIn
• Jared Sinai Hernandez GitHub / LinkedIn
• Jeison Infante: GitHub