Skip to content

Latest commit

 

History

History
30 lines (16 loc) · 1.1 KB

README.md

File metadata and controls

30 lines (16 loc) · 1.1 KB

Voxaroo_backend_api 🚀

Welcome to the Voxaroo Backend API! This project aims to provide a centralized platform for local sellers to showcase their products and connect with the community.

If you want to run this project on your machine, follow these simple steps:

Step 1️⃣

If you have 🐋docker on your system make sure to run the docker compose -f docker-compose-dev.yml up to start a mysql server and a phpmyadmin visual interface just go to localhost:8080.

user: root password admin123

OR

Create your own MySQL server with XAMPP, LAMPP or WAMPP and database and execute the SQL code found in the .sql file provided within the project.

Step 2️⃣

Run npm install to install all the necessary development and production dependencies.

Step 3️⃣

Create a .env file following the same structure as the .env.example file in the project directory. Then, run npm run dev.

Step 4️⃣

Explore the api.http file to discover the endpoints and make requests to your local server.

Feel free to reach out if you have any questions or need assistance. Happy coding! 🌟