📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 VenomPrecision

VenomPrecision is a website that lists paintball game products and accessories.

🛠 Built With

Tech Stack

Client

• React.js
• Redux Toolkit
• Tailwind CSS
• Vite

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Create and manage your paintball items
• Reserve items with city and date
• Manage your reservations

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

You need a machine with Ruby and Node.js installed. You also need to have PostgreSQL installed and running.

Setup

Clone this repository to your desired folder:

  git clone https://github.com/limavfabio/VenomPrecision-front-end.git

Install

To install the project's dependencies, run the following command:

  npm install

Usage

You can run the dev server with the following command:

  npm run dev

Run tests

To run tests, run the following command:

  npm run test

Deployment

You can build the project with the following command:

  npm run build

The build files will be located in the dist folder.

(back to top)

👥 Authors

👤 Fábio Vinícius Dias Lima

• GitHub: @limavfabio
• Twitter: @limavfabio
• LinkedIn: LinkedIn

👤 Jakaria Jishan

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Marcelo Alarcon Barrenechea

🇧🇴 Bolivia 💓

• GitHub: @chelobotix
• Linkedin: Marcelo Alarcon

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Full fledged login and account management
• App wide search
• See and follow other profiles

(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, give it a ⭐️!

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse team for the code review and the support during this project.

The design of this project was based on the work by Murat Korkmaz on Behance. You can find it here.

(back to top)

📝 License

This project is MIT licensed.

(back to top)