Giter Club home page Giter Club logo

ecommerce-api's Introduction

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 [email protected]: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

ecommerce-api's People

Contributors

officialozioma avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.