Skip to content

Editing README for Simpl-SDK #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Editing README for Simpl-SDK #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8739c13
add README for Simpl-CLI
sangcu Oct 21, 2017
ac22b24
Merge pull request #1 from sangcu/sangcu-update-sdk-structure
sangcu Oct 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# simpl-sdk
A docker image that consist of .netcore sdk, nodejs and postgresql-client
# A toolkit for module's author to quickly add module into SimplCommerce
SimplCommerce is a platform based on modular architecture at https://github.com/simplcommerce/SimplCommerce. This project aiming to build a toolkit for module's authors can generate the skeleton of the project and integrate into SimplCommerce in one step.
## Simpl-CLI
Simpl-CLI would be installed into the development environment to generate skeleton of the module. Several commands to create the module for SimplCommerce:
### simpl init module_name
This command will generate a module that following the requirement of SimpleCommerce rules.

The module will be created in the current directory and will be validating the relationship with others modules like `SimplCommerce.Infrastructure.csproj` and `SimplCommerce.Module.Core.csproj`
### simpl build
Performing the steps for packing the module includes of:
* Assets are concatenating for admin pages.
* Generate scripts for database
* Zipping module into a package
* Generate config files

### simpl deploy simplcommerce_path
The step to deploy the module into SimplCommerce at a specific path as below:
* Validate the existing of module file in current directory
* Extract and copy assets into SimplCommerce
* Adding assets for Admin
* Run scripts to create database migration.
## Docker Image
A docker image that consists of .netcore SDK, Node.js and PostgreSQL-client