Car Shop

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Cart Shop

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.

🛠 Built With

Tech Stack

Key Features

• 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

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

  ruby version 3.3.1
  gem install rails
  docker run hello-world

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:cvalencia1991/carro-de-compras.git

Install

Install this project with:

  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

  bundle install
  rails server

if you are working on docker you need first put the image and the render the command in the terminal

  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

  docker compose up

Run tests

To run tests, run the following command:

  rspec .

Deployment

You can deploy this project using:

  railway
  render

(back to top)

👥 Authors

👤 Cesar Alberto Valencia Aguilar

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Deploy in a front end framework

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give me start ⭐️

(back to top)

❓ FAQ (OPTIONAL)

• Which framework or library could use to deploy the API in the front end development

  • you can deploy in any framework that you want

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)