Skip to content

Latest commit

 

History

History
82 lines (65 loc) · 2.61 KB

README.md

File metadata and controls

82 lines (65 loc) · 2.61 KB
Raw

Rails Header

Welcome to OT367-SERVER

RESTful Api in Ruby on Rails

A RESTful API in Ruby on Rails is a web application programming interface that adheres to the principles of Representational State Transfer (REST) and is built using the Ruby on Rails framework. REST is a set of constraints and principles for designing networked applications that use HTTP. In a RESTful API, resources are represented as URLs, and HTTP methods (GET, POST, PUT, DELETE, etc.) are used to perform operations on these resources.


Table of Contents
  1. About The Project
  2. Getting Started
  3. Endpoints
  4. APIs Used
  5. Other Technologies Used
  6. Contributors
  7. Future Iterations

Built With

Ruby Ruby on Rails Rspec Badge Postgresql

Getting Started

If you'd like to demo this API on your local machine:

  1. Ensure you have the prerequisites
  2. Clone this repo: `git clone git@github.com:Tinix/OT367-SERVER.git
  3. Navigate to the root folder: `cd OT367-SERVER
  4. Run: bundle install
  5. Run: rails db:{create,migrate}
  6. Inspect the /db/schema.rb and compare to the 'Schema' section below to ensure migration has been done successfully
  7. Run: rails s
  8. Visit http://localhost:3000/

Prerequisites

  • Ruby Version 3.2.2
  • Rails Version 7.1.1
  • Bundler Version 2.4.20
  • RSpec Version 6.0

Testing

To test the entire spec suite, run bundle exec rspec. All tests should be passing.

(back to top)