dirkgaston/jewel-store

Advanced API REST design

Jewel Store

Jewel Store is an API REST with filtering capabilities.

This project was developed as the *Advanced API REST Design** assignment in the Backend with Node and Express course for Desafio LATAM's **Full Stack with JavaScript** bootcamp

Assignment Background 📖

The jewelry store My Precious Spa needs to change its desktop application for a modern and dynamic one. To perform this task, it contacted a Full Stack Developer to develop the REST API of a client application to meet the specific needs of its users in an efficient, maintainable and effective way.

You will need to create a REST API that allows:

1. Resource limiting
2. Resource filtering by fields
3. Pagination
4. Sorting
5. HATEOAS data structure

Installing Jewel Store 🧰

To install Jewel Store, use the following command:

$ npm install

Using Jewel Store 💻

To use Jewel Store, just run the server with the following command:

$ npm run dev

the URL is:

http://localhost:3000/

Tools 🛠️

• JavaScript
• Node.JS
• Express
• PostgreSQL

Dependencies 🚧

Used dependencies include:

• Dotenv - Zero-dependency module to manage environment variables.
• Morgan - HTTP request logger middleware for Node.js.
• Morgan Body - HTTP request body logger middleware for Node.js
• Nodemon - Automatically restarting the node application when file changes in the directory are detected.
• PG - PostgreSQL client for Node.js
• PG Format - Node.js implementation of PostgreSQL format() to safely create dynamic SQL queries.
• Yup - Schema builder for server-side data validation
• CSB Inspector - Identifies the file and code line where the “console.log (data)” screen printing is being executed

Contact 📫

If you want to contact me you can reach me at [email protected].