limavfabio / VenomPrecision-back-end

The back-end for the Ibook app made with Rails.

VENOM PRECISION BACK-END

📗 Table of Contents

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

📖 VENOM PRECISION BACK-END

VENOM PRECISION BACK-END is a Ruby on Rails application to provide endpoints for "VENOM PRECISION FRONT-END". This aplication will return information in JSON format according to requests from front-end application.

🛠 Built With

Tech Stack

Backend

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Api End-Point => /api/docs
• Postgress Db
• Active Records

Live Demo

• Venom Precision Backend

(back to top)

💻 Getting Started

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

Prerequisites

You need the following tools be installed in your computer:

• Ruby
• Rails
• Git
• Postgresql

Setup

Clone this repository to your desired folder:

  cd my-prefered-folder

  git clone https://github.com/limavfabio/VenomPrecision-back-end.git

Install

Install this project with:

  cd VenomPrecision-back-end

  bundle install

💾 Database

Create the databases and run migrations with:

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

Usage

To run the project, execute the following command:

rails server

Run tests

To run tests, run the following command:

rspec spec

If you are having problems with tests, please make sure you have executed:

rails db:migrate RAILS_ENV=test

Frontend

You can find the frontend application here

Endpoint

You can find all endpoints documentation on here

Deployment

To deploy this application you can use Heroku, Render or similar.

(back to top)

👥 Authors

👤 Anderson Canales

• GitHub: @anderCM
• LinkedIn: /andersoncanales
• Portfolio: https://anderson-cm-portfolio.netlify.app/

👤 Marcelo Alarcon

• GitHub: @chelobotix
• LinkedIn: /marceloalarconb
• Portfolio: https://chelobotix.github.io/Portafolio-Website/

👤 Jakaria Jishan

• GitHub: @JakariaJishan
• LinkedIn: /jakaria-jishan
• Portfolio: https://jakariajishan.github.io/portfolio-microverse/

👤 Fábio Lima

• GitHub: @limavfabio
• LinkedIn: /fábio-lima-a28b16182
• Portfolio: https://www.linkedin.com/in/f%C3%A1bio-lima-a28b16182/

(back to top)

🔭 Future Features

• CRUD for budges
• Authentication
• Permissions

(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 give it a star 😁🌟✨

(back to top)

🙏 Acknowledgments

Thanks to Microverse for providing us with the right material to aid this project development

(back to top)

📝 License

This project is MIT licensed.

(back to top)