MiniCommerce

MiniCommerce is a node.js based web service that using Elevenia API implementation under the hood

Getting Started

This is how you may setting up your project locally. To get a local copy up and running follow these simple example steps.

Requirements

Here is the requirement to run this project, please install the right software properly.

Software	Version	Note
Node	>14	needed for the newer ES version
Postgresql	12

(back to top)

Installation

Below is how to installing and setting up the service.

1. Get a free API Key at (http://soffice.elevenia.co.id/login.do).
2. Clone the repo

   git clone https://github.com/ardhyanth/miniCommerce.git

3. Install NPM packages

   npm install

4. Enter your API in .env

   const ELEVENIA_KEY = 'ENTER YOUR API';

5. For the DDL, you can see DDL.sql in project root. This is necessary to be executed due to the usage of trigger function that helps recalculating some field used in this project.

(back to top)

Usage

Running development mode.

Currently for development purpose only.

npm run dev

after a bit of time, you will see this log on the terminal

Server running on http://localhost:3000

and the server is ready for next development/trial

Running test

npm run test

(back to top)

API Documentation

For the API documentation, we are using swagger with the integration of Joi and Hapi.js. You can access more detailed documentation of the API on /docs, after the service is running.

Roadmap

• Add Swagger
• Add core functionality
• Add endpoint proxy to Elevenia
• Add unit test
• Restructure code hierarchy
• add more unit test and complete coverate

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)