https://github.com/tresor11/cafe-react-api

A rails API serving as a backend to a cafe-menu react app.
https://github.com/tresor11/cafe-react-api

heroku rails-api

Last synced: about 1 month ago
JSON representation

A rails API serving as a backend to a cafe-menu react app.

• Host: GitHub
• URL: https://github.com/tresor11/cafe-react-api
• Owner: Tresor11
• Created: 2021-05-29T05:07:17.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-05-31T04:23:22.000Z (over 3 years ago)
• Last Synced: 2023-03-03T01:34:54.804Z (over 1 year ago)
• Topics: heroku, rails-api
• Language: Ruby
• Homepage: https://cafe-react.netlify.app/
• Size: 182 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cafe-React API

> This project is an Api for this [React-app](https://resell-app.netlify.app/).

This API is made of one model called Item

The API has the following endpoints

`GET /items`

returns all the items

`POST /items`

allows user to create an item

`GET /items/id`

returns a specific item

`PUT /items/id`

allows user to edit an item

`DELETE /items/id`

allows admin to delete an item

## Built With

- Rails

- Ruby 

- Heroku

## Getting Started

Here are the steps to follow in order to get this project on your local computer.

### Prerequisites

`rails v6.0.3 +`

`ruby v2.7.1 +`

### Setup

clone this repo by typing `git clone https://github.com/Tresor11/cafe-react-api.git`

### Install

install the dependencies by typing `bundle install`

### Usage

start the local server by running `rails s`

### Testing

run the tests by typing `bundle exec rspec`

### Deployment

this project is deployed on heroku

## Author

👤 **Tresor bireke**

- Github: [@Tresor11](https://github.com/Tresor11)

- Twitter: [@Tbireke](https://twitter.com/Tbireke)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the [issues page](issues/).

## 📝 License

This project is [MIT](lic.url) licensed.