Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ovflowd/ecommerce
:handbag: A simple restful API for Purchases and Products
https://github.com/ovflowd/ecommerce
api grails groovy java pismo products purchases restful saas
Last synced: about 2 months ago
JSON representation
:handbag: A simple restful API for Purchases and Products
- Host: GitHub
- URL: https://github.com/ovflowd/ecommerce
- Owner: ovflowd
- License: gpl-3.0
- Created: 2017-08-03T15:43:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-13T16:08:48.000Z (almost 7 years ago)
- Last Synced: 2024-10-04T13:30:08.322Z (3 months ago)
- Topics: api, grails, groovy, java, pismo, products, purchases, restful, saas
- Language: Groovy
- Homepage: http://santoro.pw/ecommerce/
- Size: 80.2 MB
- Stars: 19
- Watchers: 1
- Forks: 30
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
### :handbag: A simple RESTful API for Purchases and Products
[](https://www.gnu.org/licenses/gpl-3.0) []() []() [](https://travis-ci.org/ovflowd/ecommerce) []() []() []()
## Deploy
## Features
Products Features
| Feature | Coded? | Description |
|----------|:-------------:|:-------------|
| Add a Product | ✔ | Ability of Add a Product on the System |
| List Products | ✔ | Ability of List Products |
| Edit a Product | ✔ | Ability of Edit a Product |
| Delete a Product | ✔ | Ability of Delete a Product |
| Stock | ✔ | Ability of Update the Stock |
| Stock History | ✔ | Ability to see the Stock History |
Purchase Features
| Feature | Coded? | Description |
|----------|:-------------:|:-------------|
| Create a Cart | ✔ | Ability of Create a new Cart |
| See Cart | ✔ | Ability to see the Cart and it items |
| Remove a Cart | ✔ | Ability of Remove a Cart |
| Add Item | ✔ | Ability of add a new Item on the Cart |
| Remove a Item | ✔ | Ability of Remove a Item from the Cart |
| Checkout | ✔ | Ability to Checkout |
# eCommerce
**eCommerce** it's an open source (test scenario) software made to create a easy and simple "Shop" API, where you have two micro services, one the **Products API** that stores and handles everything Related to Stock and Products. And the **Purchase API** where you can create orders (cart's) and checkout items.
The purpose of this repository it's for education and test. But the code it's being coded in a proper way.
## Documentation
**eCommerce** has a full API documentation made with [Swagger](https://swagger.io), you can check it by accessing [this](http://santoro.pw/eCommerce) link.
If you have any **Issue** or bug you can submit a new Issue by accessing [this](issues/) link.
If you want to **Contribute** you can submit a Pull Request, remember to READ the [Contributing Guide](CONTRIBUTING.md)
## Installation
* **eCommerce** it's splitted into two standalone RESTful API's, so you can run it on whatever port you want. Installing
* **eCommerce** it's easy, the tutorial above will explain to you.
* **eCommerce** uses Groovy `2.4` and Grails `3.2.11`.
You can run **eCommerce** in different ways. You can go to the [Releases Page](releases/) and download the source code of the latest release, or a bundled .war or a standalone java application (.jar).
**It's recommend see the notes on [this](#notes) section.**
### Development
You can attach the .war in WebServers like **Tomcat** using the Management Interface.
If you want run the standalone `.jar` just download it, and open your CMD/Terminal and write:
**If you want RUN the Products API**
`java -jar ecommerce-products-api-XXX.jar` **OR** `./products-api/grailsw run-app`
**If you want RUN the Purchases API**
`java -jar ecommerce-purchase-api-XXX.jar` **OR** `./purchase-api/grailsw run-app`
You also can build from the sources by running the **Grails Console**, just went to one of the API's folder `purchase-api` or `products-api` and write on your CMD/Terminal the following:
`grailsw assemble`
If you want to run it in development scenario, you can also do it by **building** the sources. You have two manner to do it. You can Gradle or directly Grails. Both `products-api` and `purchase-api` comes with Groovy, Grails and Gradle standalone packages. So you can run it without the need of installing they.
**Option #1 - Run by Gradle**
`gradlew bootRun`
**Option #2 - Run by Grailsw**
`grailsw run-app`
### Production
Production Environments are focused in being ready. That means, you just need execute the Jar File.
In the Production Environment all eCommerce API's are configured to work with **MySQL** in two databases; **productsAPI** and **purchaseAPI** and to work with a default **username and password** combination:
**Note.:** Remember importing each SQL files, if using MySQL for Production. You can find them inside `products-api/src/main/sql/` and `purchase-api/src/main/sql/`
* **Username:** commerce
* **Password:** commerceapi
* **Database:** productsapi & purchaseapi
* **Port:** 3306
You can change those credentials in the `application.yaml` file. In production environments **you need import the database schema** before running the software. Both `products-api` and `purchase-api` DDL files are available on [this](sql/) folder.
### Notes
**Note.:** By default `products-api` runs on port 8080 and `purchase-api` on port 8090.
**Note.:** In all Development and Test Scenarios, eCommerce uses **H2** in-memory Database.
**Note.:** You can change your database credentials both for development/test and production scenarios in the `app-config.yml` available on each API sources root. Those configuration files can be used also externally, after building the `.jar`
**Note.:** You also can clean the sources and rebuild the sources by running `grailsw clean`
## Running Test Cases
You can easily run the **Test Cases** using the standalone Grails package built-in with both the API's. Just went to the home folder of one of them (`products-api` or `purchase-api`). And write on your CMD/Terminal:
`grailsw test-app`
## Credits
This development/educational scenario was coded and created by [Claudio Santoro](http://santoro.pw) unde the [GNU GPL v3](LICENSE) License. The objective of this repository it's as practical test of RESTful API's with Java + Groovy.