jaferIdrees/book_recomendation_frontend

Synergy

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• Kanban Board
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 [Synergy book library]

Your Next Office outside the Office.

[Synergy book library] Individuals, can build their own libraries out from Open Library API, add each book status if read or to be read, add their reviews and ratings.

🛠 Built With

Tech Stack

This is a React Front-End App to authenticate(sign-up or login) and give access to all the CRUD funtions to add books to their libraries and reveiw them.

API Repository

Client

• React.js
• Javascript

Server

• Ruby On Rails

Database

• PostgreSQL

Key Features

Our React Front-End have great feautures.

• All routes are protected if you are not loggedin
• JWT validation in header requests

(back to top)

💻 Getting Started

Please Fork or Clone this repo.

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node.js.

 node -v

If you get something like this v16.15.0, you have node installed. Otherwise follow this link to download and install it.

• NPM.

 npm -v

If you get something like this 9.2.0, you have node installed. Otherwise follow this link to download and install it.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:jaferIdrees/book_recomendation_frontend.git

Install Dependencies

Install this project with:

  cd my-project
  npm install

Usage

To run the project, execute the following command:

  npm start

Your server will run on http://localhost:3000

Run tests

To run tests, run the following command:

  npm test

👥 Authors (Synergy team)

This is the awesome team (4 members) that built this project.

👤 Ja'fer Yousef

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: jaferll

👤 Romita Pawar

• GitHub:
• Twitter:
• LinkedIn: Romita Pawar

👤 Sneha Singh

• GitHub: @githubhandle
• Twitter:
• LinkedIn: Sneha Singh

👤 Olatunde O

• GitHub:
• Twitter:
• LinkedIn: Olatunde O

(back to top)

(back to top)

FUTURE FEATURES

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Add Redux for state management.
• Show API notifications.
• Enhance the styling.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...give us a ⭐️.

(back to top)

📝 License

This project is MIT licensed.

(back to top)