Loading repository data…
clintonbrito / repository
restful-api-ecommerce
This repository contains the backend challenge project for a job application. It is a RESTful API built with AdonisJS (Node.js) and MySQL for managing users, clients, products, and sales. The project follows the MVC architecture and includes user authentication with JWT.
#adonisjs#jwt#mysql#nodejs#rest-api#restful-api
Live repository statistics
★ 0Stars
⑂ 0Forks
◯ 1Open issues
◉ 0Watchers
29/100
OPENREPOHUB HEALTH SIGNAL
Limited signals
A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
10
Community adoption25% weight
0
Maintenance state20% weight
40
License clarity10% weight
100
Project information10% weight
75
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
README preview
RESTful API E-Commerce Project
This is a MVP e-commerce-like API developed from scratch. It allows you to manage users, clients, products and sales. The project follows the MVC architecture and includes user authentication with JWT.
🧪 Technologies
This project was developed using:
🚀 Getting started locally
Check the docker logs using the command docker logs -f app which address is running the application and open your browser or any prefered API client in order to test the endpoints through the address below, for example:
📖 API Documentation
Explore the API documentation to understand the available endpoints, request parameters, and responses. The documentation is built using Bruno 🐶, a fast and Git-friendly Opensource API client, which also provides an interactive and user-friendly interface.
Accessing API Documentation
-
Run the Application: Make sure the application is running locally. Follow the Getting Started section for instructions on starting the application.
-
Feel free to give a try to Bruno and download it: Check out the Download page and follow the instructions.
-
Open Bruno Desktop App: Once the application Docker containers are running ok, you can access the Bruno Desktop App.
-
Explore Endpoints: In the Bruno Desktop App, you just need to import
/docs/Ecommerce APIcollection folder and voilà: you'll find a list of available endpoints along with details about request parameters. Use this interface to understand how to interact with the API. The base URL of the API which you should use as an environment variable on Bruno is the following:
