Skip to content

Adrenalineren/Bookies

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 Bookies

Bookies is a web application for avid readers to write reviews of books they've read and share them with friends. It also lets users maintain a personalized reading list to track books they want to read in the future.


🚀 Tech Stack

Frontend: React
Backend: Node.js, Express
Database: MongoDB
Full Stack: MERN (MongoDB, Express, React, Node.js)


👩🏻‍💻 Software Engineering Practices

1. Version Control

Our team uses Git to track changes, collaborate effectively and manage code versions. This allows us to maintain a clear development history, revert to previous versions when needed, and work simultaneously on different features of our web application without conflict.

2. Code Readability

We prioritize code clarity by following consistent naming conventions in our code, such as CamelCase for every variable and function. We also use meaningful and descriptive names to make our code easier to understand and maintain.

3. Modular Design

In our web application, each component is organized in its own file, keeping the codebase clean and manageable. This structure promotes code reusability, simplifies debugging and enhances maintainability.


📦 Installation

Follow these steps to run the project locally:

1. Clone the repository

git clone https://github.com/your-username/bookies.git
cd bookies

2. Start the backend

cd api
npm install
npm install node-fetch@v2
npx nodemon index.js

This runs the Express backend server on http://localhost:4000.

3. Start the frontend

In a new terminal window:

cd client
npm install
npm start

This will start the React frontend on http://localhost:3000.


💡 Usage

Open your browser and go to: http://localhost:3000. Register or log in.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •