Welcome to Mrittik-Server – an open-source REST API developed with Node.js and Express.js! This project is designed to help developers easily integrate searching, sorting, and filtering functionality into their applications.
Use these APIs for building e-commerce or any project that requires advanced query capabilities.
| 🛠Feature | 🔗Endpoint | 📌Example |
|---|---|---|
| Get Categories | /category |
View Categories |
| Get Products by Category | /products/category/${id} |
Example |
| Search Categories | /category?[dataProperty]=[dataValue] |
By Name<br>By ID |
| Get All Products | /products |
View All Products |
| Get Product by ID | /products/${id} |
Example |
| Search Products | /products?[dataProperty]=[dataValue] |
By Name<br>By ID |
| Get All Tags | /tags |
View Tags |
| Search by Tag | /products?[TagName]=[SearchItem] |
Example |
| Get All Brands | /brands |
View Brands |
| Search by Brand | /products?[BrandName]=[SearchItem] |
Example |
| 💻Feature | 🏠Endpoint | 📌Example |
|---|---|---|
| Get Categories | /category |
Local Categories |
| Get Products by Category | /products/category/${id} |
Example |
| Search Categories | /category?[dataProperty]=[dataValue] |
By Name<br>By ID |
| Get All Products | /products |
Local Products |
| Get Product by ID | /products/${id} |
Example |
| Search Products | /products?[dataProperty]=[dataValue] |
By Name<br>By ID |
| Get All Tags | /tags |
Local Tags |
| Search by Tag | /products?[TagName]=[SearchItem] |
Example |
| Get All Brands | /brands |
Local Brands |
| Search by Brand | /products?[BrandName]=[SearchItem] |
Example |
To start working with Mrittik-Server, follow these steps:
- Install Node.js.
- Install Yarn globally:
npm install --global yarn
git clone https://github.com/hbkabir004/Mrittik-Server.gitNavigate to the project folder in your terminal and run:
yarn installRun the following command to start the development server:
node index🌟 Your local server is live at: http://localhost:4000
We ❤️ contributions! Check out CONTRIBUTING.md for details on how you can improve this project.
Have questions or suggestions? Feel free to open an issue or reach out with your feedback. Let's build something awesome together! 🌟