Storm Mountain API

This is an API built on Ruby on Rails and PostgreSQL, where it is possible to create users, activities and schedules.

Built With

• Ruby 3
• Ruby on Rails 6
• PostgreSQL
• Shoulda Matchers
• Rspec
• Faker
• FactoryBot

Live version

You can check the live version in this link

You can also check the React app consuming this API here

Documentation

The complete documentation can be found here

Getting Started

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

Prerequisites

• Ruby on Rails v 6.x. For more information on how to install Ruby on Rails, please follow this link

• Make sure you have PostgreSQL installed on your machine. For more information on how to set it up please follow this tutorial

Setup and Install

• Clone this repository using the link above (click on the 'code' button)
• Open a terminal and cd to the cloned repository
• Run bundle install to install ruby gems required the dependencies
• Run yarn to install javascript required the dependencies
• Run bin/rails db:create to create database
• Run bin/rails db:migrate to migrate the database

Usage

• Run bin/rails server to start the server
• Enter output address from your terminal on your browser to access the page, for instance:

 Listening on http://127.0.0.1:3000

Tests

To run the tests, move to the root folder of the project and enter the following command:

  $ bundle exec rspec

Authors

👤 Gustavo Carvalho

• GitHub: @gscarv13
• Twitter: @Gscarv13
• LinkedIn: Gustavo Carvalho

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.