Final Capstone Back End

📗 Table of Contents

• 📗 Table of Contents
• 📖 final_capstone_back_end
  • 🛠 ER Diagram
  • 💻 link to front end
  • 💻 link to Kanban board information
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Database Setup
    • Usage
  • 🔬 Running Tests
    • Test Suite
  • 💻 API Documentation
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 Final Capstone Back End

final_capstone_back_end The back-end component of this final capstone project is developed using Ruby on Rails, configured to serve as an API. This API is designed to facilitate creation of places to rent, and to allow users to make reservations for those places. It leverages a PostgreSQL database to manage and store reservation data. The API is designed to be consumed by a front-end application, which is developed using React.js.

🛠 ER Diagram

(back to top)

💻 Link to front end

Link to Front End

(back to top)

💻 link to Kanban board information

Link to Kanban Board

Initial state

This project was completed by three Team members:

• Javier Grau
• Manuel Sanchez
• Anthony Vásquez

(back to top)

🛠 Built With

Tech Stack

Technologies

• Ruby on Rails

Linters

• Rubocop

Key Features

• Ruby on Rails
• API Endpoint
• Professional Documentation
• Linting for Code Quality
• Postgres Database
• Git Version Control

(back to top)

💻 Getting Started

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

Prerequisites

Before you begin, ensure you have the following prerequisites installed on your system:

• Ruby: You need Ruby to run the Ruby on Rails application.
• Bundler: Bundler is used to manage gem dependencies for your Ruby project.

Setup

In your terminal, navigate to the folder of your choice and clone the repository with the following commands:

cd my-folder
git clone [email protected]:grauJavier/final-capstone-back-end.git

Install

After cloning the project, change into the project directory:

cd final_capstone_back_end

Install this project with:

• gem install rails
• bundle install

Credentials setup

In order to create databases and run the tests, you need to follow this steps:

1. Remove config/master.key and config/credentials.yml.enc if they exist.
2. Run rails secret. This will generate a key. Copy and reserve the key to use later.
3. If you use Windows run: $env:EDITOR="code --wait"; rails credentials:edit If you use Linux run: EDITOR="code --wait" bin/rails credentials:edit
4. Your editor will open a file, add at the bottom devise_jwt_secret_key: <the key you copied in step 2>
5. Save the file and close the editor. New master.key, credentials.yml.enc files will be generated, and the key will be stored in Rails.application.credentials.devise_jwt_secret_key.

Database Setup

Create and migrate your database with:

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

Usage

To run the project, execute the following command:

rails server
or
rails s

This should start your local server on http://localhost:3000/. Now, you can use the REST API client of your choice to interact with the API.

(back to top)

🔬 Running Tests

To run tests, navigate to the directory where the project is located on your machine, open your terminal, and follow these steps:

Test Suite

This project contains a suite of unit tests which you can run to ensure everything is functioning as expected. To run these tests, you need RSpec installed.

To install RSpec if you haven't already, run:

gem install rspec

After you've installed RSpec, you can run the tests with:

rspec

(back to top)

💻 API Documentation

API Documentation

(back to top)

👥 Authors

👤 Javier Grau

• GitHub: @grauJavier
• LinkedIn: Javier Grau

👤 Manuel Sanchez

• GitHub: @Luffytaro22
• LinkedIn: Manuel Sanchez

👤 lRebornsl

• GitHub: @lRebornsl
• Twitter: @RebornsDev
• LinkedIn: Anthony Vásquez

(back to top)

🔭 Future Features

• Implement proper user authentication from the front-end to the server
• Add authorizations to users

(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 like this project please feel free to send me corrections for make it better I would feel glad to read your comments. And think If you enjoy gift me a star.

(back to top)

🙏 Acknowledgments

• Behance and Murat Korkmaz for the original design
• Microverse for providing the opportunity to learn in a collaborative environment.
• React.js Documentation for valuable resources on React development.
• GitHub for version control and collaboration tools.

(back to top)

❓ FAQ (OPTIONAL)

• Can I use with a templeate your project?

  • Of course we would feel honored.

• Your project is free license?

  • Yeah, you can use it completely.

(back to top)

📝 License

This project is licensed under the MIT License - you can click here to have more details MIT.

(back to top)