https://github.com/tresor11/e-commerce-api

A Ruby on Rails API for a resale app - with full support for create, read, update, and delete actions. This API utilizes JSON web token authentication to ensure that only authorized users have access to sensitive data.
https://github.com/tresor11/e-commerce-api

heroku jwt-authentication rails-api rspec

Last synced: about 15 hours ago
JSON representation

A Ruby on Rails API for a resale app - with full support for create, read, update, and delete actions. This API utilizes JSON web token authentication to ensure that only authorized users have access to sensitive data.

• Host: GitHub
• URL: https://github.com/tresor11/e-commerce-api
• Owner: Tresor11
• Created: 2020-06-22T08:00:49.000Z (over 4 years ago)
• Default Branch: development
• Last Pushed: 2024-12-12T12:19:20.000Z (16 days ago)
• Last Synced: 2024-12-13T17:31:27.960Z (15 days ago)
• Topics: heroku, jwt-authentication, rails-api, rspec
• Language: Ruby
• Homepage: https://resell-app.netlify.app/
• Size: 4.75 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Resell-App API

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

This API is made of three models:

- User model

- Item model

- Favorite model

The API has the following endpoints:

`POST /auth/login`

allows user to authenticate and return a token

`POST /signup`

allows user to create an account

`GET /profile`

returns the user information

`POST /profile`

allows user to edit their profile

`GET /items`

returns all the items

`POST /items`

allows admin to create an item

`GET /items/id`

returns a specific item

`PUT /items/id`

allows admin 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/final-capstone-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/).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Hat tip to anyone whose code was used !

## 📝 License

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