https://github.com/tinix/ot367-server-api

RESTful Api Ruby
https://github.com/tinix/ot367-server-api

api aws-s3 circleci docer-compose docker documentation gihub-actions json jwt jwt-authentication kubernetes rail rspec ruby

Last synced: 3 days ago
JSON representation

RESTful Api Ruby

• Host: GitHub
• URL: https://github.com/tinix/ot367-server-api
• Owner: Tinix
• License: apache-2.0
• Created: 2023-10-24T16:39:19.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-01-14T00:47:03.000Z (9 months ago)
• Last Synced: 2024-09-20T05:30:54.167Z (7 days ago)
• Topics: api, aws-s3, circleci, docer-compose, docker, documentation, gihub-actions, json, jwt, jwt-authentication, kubernetes, rail, rspec, ruby
• Language: HTML
• Homepage:
• Size: 465 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        





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

  


    


      About The Project

      


        
Built With

      

    

    


      Getting Started

      


        
Prerequisites

        
Schema

        
Testing

      

    

    
Endpoints

    
APIs Used

    
Other Technologies Used

    
Contributors

    
Future Iterations

  





### Built With

![Ruby](https://img.shields.io/badge/Ruby-CC342D?style=for-the-badge&logo=ruby&logoColor=white)

![Ruby on Rails](https://img.shields.io/badge/Ruby_on_Rails-CC0000?style=for-the-badge&logo=ruby-on-rails&logoColor=white)



![Postgresql](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white)

## 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 [email protected]: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)