HFG43 / Api-rest-nexo-soluciones

API Nexo Soluciones

📗 Table of Contents

• 📗 Table of Contents
• About
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • ERD
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run linters
  • 👥 Authors
  • 📝 License

---

About

"API Nexo Soluciones" is an API designed to host people data and their addresses. It was designed in Ruby on Rails and PostgreSQL.

---

🛠 Built With

Tech Stack

Backend

• Ruby on Rails
• PostgreSQL
• API Documentation (Swagger)

Linters

• Rubocop

Key Features

• Ruby on Rails framework
• Use Linters to check code quality
  • Rubocop
• MVC architectural/design pattern
• Data persistent in PostgreSQL
• RESTful API
• Swagger to generate API doc
• People endpoints

(back to top)

---

ERD

On the following ERD you can see the structure of this project.

(back to top)

---

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• A code editor (we recommend Visual Studio Code)
• Git and a GitHub account
• Ruby on Rails, you can get it here
• PostgreSQL, you can get it here

Setup

Clone this repository to your desired folder by using the command:

git clone https://github.com/HFG43/Api-rest-nexo-soluciones.git

Install

Go to the project directory:

 cd final_capstone_back_end

Before to run the program, run the following command to install the necessary gems:

 bundle install

After installing the gems, run the following command to create and migrate the database:

 rails db:create
 rails db:migrate

Usage

Run the following command inside the project folder to start the application:

  rails s

Testing

On this app you can find different test of models and request in the spec directory, to run them follow any of the following commands:

  rspec
  bundle exec rspec

Those commands will start the application on your local server. You can now open your browser and go to http://localhost:3000/ to see the application running.

Remember that this is an API so, to read the documentation follow this link after started the server.

Run linters

To verify that the ruby code is written without errors and meets good practice standards, run the following command inside the project folder:

• ruby linter:

 rubocop

To fix the linter use any of the following options:

  rubocop --fix
  rubocop -A

(back to top)

---

👥 Authors

👤 Hernán Güemes

• GitHub: @HFG43
• LinkedIn: hernanguemes

(back to top)

---

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

---

📝 License

This project is MIT licensed.

(back to top)

---