Skip to content

OfficialOzioma/ecommerce-api

Repository files navigation

This is Mini eCommerce API, Built using AdonisJs version 5, for the full documentation on how to use this API visit the documentation page below

Build Status

Mini eCommerce API is a crud API that has the following features.

Features

  • User Authenication
  • Perform Category CRUD
  • Perform Sub Category CRUD
  • Perform Product CRUD

Technologies

This Mini eCommerce API was built with the following Technologies:

  • NodeJs - Nodejs is a JavaScript runtime built on Chrome's V8 JavaScript engine.
  • AdonisJs - A fully featured web framework for Node.js!
  • TypeScript - TypeScript is JavaScript with syntax for types.
  • PostgreSQL - PostgreSQL is a powerful, open source object-relational database system.
  • Postman - Postman is an API platform for building and using APIs.

Installation

This API requires Node.js v12+ to run. You need git install on your PC Install the dependencies and devDependencies and start the server.

Run the following command on your

git clone git@github.com:OfficialOzioma/ecommerce-api.git
cd ecommerce-api
npm install
node ace migration:run
node ace serve --watch

API End points

For a complete documentation of this API visit the documentation page. Click here

Note: category and sub category is required for for creating a product

table

Details Method API End points
Register POST api/register
Login POST api/login
Create Category POST api/category
Get All Categories GET api/category
Find a category GET api/category/:id
Update a Category PUT api/category/:id
Delete a Category DELETE api/category/:id
Create Sub Category POST api/sub-category/
Get all Sub Categories GET api/sub-category/
Find a Sub category GET api/sub-category/:id
Update a Sub Category PUT api/sub-category/:id
Delete a Sub Category DELETE api/sub-category/:id
Create Product POST api/product
Get all Product GET api/product
Find a Product GET api/product/:id
Update a Product PUT api/product/:id
Delete a Product DELETE api/product/:id

License

MIT