sadaf-Daneshgar / Page-To-page-Library-Backend

📖Book Library Reservation

📗 Table of Contents

• 📖 About the Project
• 🛠 Project Requirements
  • 🔗 Integration with Front-End
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 📡 API Endpoints
    • API Documentation
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Run the Project
    • Run the tests
  • 📋 Kanban Board
  • 👥 Author
  • 🔭 Issues
  • 🤝 Contributing
  • ⭐️ Show Your Support
  • 🙏Acknowledgments
  • 📝 License

Book Library Reservation

This project is a Book Library Reservation API. It is a RESTful API that allows users to reserve books from a library. It is built with Ruby on Rails and PostgreSQL. It is a capstone project for the Microverse Full-Stack Development Program.

🛠 Project Requirements

• Create a Rails API app called 'hello-rails-back-end'.
• Initialize the project with Git.
• Set up a Postgres database and create a table for storing messages.
• Populate the table with 5 different greetings.
• Create an API endpoint that selects a random greeting from the table.

🔗 Integration with Front-End

Here is the link to the Front-End repository.

(back to top)

🛠 Built With

Tech Stack

Client

• HTML5
• CSS
• JavaScript

Server

• Ruby
• Ruby on Rails

Database

• PostgreSQL

(back to top)

Key Features

• Gitflow
• Linters implemented
• Rubocop implemented
• Implement Model Migrations
• Implement Implement TailwindCSS
• Implement unit and integrations tests
• Implement authentication and authorization
• Use PostgreSQL

(back to top)

📡 API Endpoints

| Endpoint | Method | Description |

API Documentation

Link to the API Documentation

(back to top)

🚀 Live Demo

Here you can find a live demo of our frontend, that is using our own Library API (which you can also find here!

(back to top)

💻 Getting Started

To get the project up and running on your local machine, follow these steps.

Prerequisites

In order to run this project you need:

• To clone or fork this repo
• Ruby installed in your machine
• Ruby on Rails gem installed
• PostgreSQL install in you computer
• To modify this profile you will also need a text editor like VSCode or Atom.

Setup

Clone this repository to your desired folder:

git clone https://github.com/leloufadel/Page-To-page-Library-Backend.git
cd Page-To-page-Library-Backend

Install gem dependencies:

bundle install

Set up the database:

rails db:create
rails db:migrate
rails db:seed

Run the Project

To run the project, execute the following command:

rails server

Run the tests

To run the tests, execute the following command:

rspec

(back to top)

📋 Kanban Board

Here's our Project Board. Take a look at how we started!

(back to top)

👥 Author

👤 Sadaf Daneshgar

• 👤 GitHub: @Sadaf-Daneshgar
• 👤 Twitter: @SadafDaneshgar
• 👤 LinkedIn: Sadaf Daneshgar

👤 Santiago Ruido

• 👤 GitHub: @Arch-Noize
• 👤 LinkedIn: Santiago Ruido

👤 Garvin Chimone

• 👤GitHub: @Chimoneg27
• 👤Twitter: @GarvinChimone
• 👤LinkedIn: Garvin Chimone

👤 Aisha Alselwi

• 👤GitHub: Aisha Alselwi
• 👤LinkedIn: Aisha Alselwi

👤 Lala Aicha El Vadel

• 👤LinkedIn: @Lala Aicha El Vadel
• 👤GitHub: @Lala Aicha El Vadel
• 👤Wellfound: @Lala Aicha El Vadel
• 👤Twitter: @Lala Aicha El Vadel

(back to top)

🔭 Future Features

Upcoming improvements:

• [ ]

(back to top)

🔭 Issues

Find a bug or have a feature request? Open a new issue here on GitHub.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

(back to top)

⭐️ Show Your Support

If you find this project helpful, please consider starring the repository. Your support is greatly appreciated!

(back to top)

🙏 Acknowledgments

I would like to thank the following individuals and organizations for their contribution to this project.

• I would like to express my heartfelt gratitude to Microvere for the invaluable learning experience they have provided.
• We also would like to mention that the design of the website is not ours. We followed Murat Kormaz's design in Behance, and thus follow the Creative Commons License terms.

(back to top)

📝 License

This project is MIT licensed.

(back to top)