Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cvalencia1991/carro-de-compras
This is a Cart Shop Strucutre of the the item add, access and create and access implement authetication Bearer Token
https://github.com/cvalencia1991/carro-de-compras
api-rest docker docker-compose ruby-on-rails
Last synced: 3 months ago
JSON representation
This is a Cart Shop Strucutre of the the item add, access and create and access implement authetication Bearer Token
- Host: GitHub
- URL: https://github.com/cvalencia1991/carro-de-compras
- Owner: cvalencia1991
- License: mit
- Created: 2024-05-26T14:41:40.000Z (9 months ago)
- Default Branch: dev
- Last Pushed: 2024-08-08T01:48:40.000Z (6 months ago)
- Last Synced: 2024-08-08T03:56:51.808Z (6 months ago)
- Topics: api-rest, docker, docker-compose, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 149 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Car Shop
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**Cart Shop** is a API (application Programming interface) that allows the user to create an shop depends of the products
and the cart items are stablish.
.png)
Server
Database
- **When an Item is added to the Car, The system must update the item, but if reduce the item to 0, must delete the item in the car shop**
- **The user can create the user name and can asses using registration and barer token**
- **the stock must have control of each one units, make no access adding new items when the cart doesn't have stock**
- **we have two types of items: events and products, the two types must be specific but the attributes must have price, name, thumbnail and description**
- **make documentation using Rswag and Implement Testing**
- **docker the project**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
ruby version 3.3.1
gem install rails
docker run hello-world
```
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone [email protected]:cvalencia1991/carro-de-compras.git
```
### Install
Install this project with:
```sh
cd my-project
gem install
bundle install
```
### Usage
To run the project, execute the following command:
if you are working without docker you can put this commands on the bash terminal
```sh
bundle install
rails server
```
if you are working on docker you need first put the image and the render the command in the terminal
```sh
docker build -t cart-api-1 /path/to/the/project
docker run --name api-2 -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) -e DEVISE_JWT_SECRET_KEY=your_jwt_secret_key cart-api-1
```
when the Master key is inside the credentials
if you want to work in different environments you can use the next command
```sh
docker compose up
```
### Run tests
To run tests, run the following command:
```sh
rspec .
```
### Deployment
You can deploy this project using:
```sh
railway
render
```
👤 **Cesar Alberto Valencia Aguilar**
- GitHub: [@githubhandle](https://github.com/cvalencia1991)
- Twitter: [@twitterhandle](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/cesar-valencia-aguilar/)
- [ ] **Deploy in a front end framework**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/cvalencia1991/carro-de-compras/issues).
If you like this project please give me start ⭐️
- **Which framework or library could use to deploy the API in the front end development**
- you can deploy in any framework that you want
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._