An open API service indexing awesome lists of open source software.

https://github.com/ukaypromise/store-api

This is the backend for an ecommerce frontend webapp. The project was setup using ruby on rails.
https://github.com/ukaypromise/store-api

database postgresql rails-api ruby

Last synced: about 2 months ago
JSON representation

This is the backend for an ecommerce frontend webapp. The project was setup using ruby on rails.

Awesome Lists containing this project

README

          

# 📖 Store API

### Developed with Ruby on Rails to create an API for an Ecommerce webapp.
# 📗 Table of Contents

## 🛠 Built With Ruby on Rails

### Tech Stack

Database

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

Make sure you have installed locally:
Ruby
Nodejs

### Setup

Clone this repository to your desired folder

Execute on console making sure you are in the correct directory:
```sh
bundle install
npm i
```

-create a file named application.yml under config folder and write the following Variables:
```sh
USER_NAME = “xxx” (xxx replace with your Postgres user name)
PASSWORD = “xxx” (xxx replace with your Postgres password)
```
-On console execute
```sh
rails db:create
rails db:migrate
rails db:seed
```

-Create Master key:
```sh
EDITOR="mate --wait" bin/rails credentials:edit
```
```sh
rails s
```

## Testing
You may test by executing:

rspec ./spec/models

rspec ./spec/requests

rails rswag

## API documentation

Not available yet!!!

(back to top)

## 👥 Authors

👤 **Promise Uka **

- GitHub: [Ukaypromise](https://github.com/Ukaypromise)
- Twitter: [@PromiseUkay](https://twitter.com/PromiseUkay)
- LinkedIn: [Promiseuka](https://www.linkedin.com/in/promiseuka/)

(back to top)

(back to top)

## 📝 License

This project is [MIT](./MIT.md) licensed.

(back to top)