https://github.com/aergoio/ship
Aergo Lua Contract Package Manager
https://github.com/aergoio/ship
aergo lua-contract package-manager
Last synced: 15 days ago
JSON representation
Aergo Lua Contract Package Manager
- Host: GitHub
- URL: https://github.com/aergoio/ship
- Owner: aergoio
- License: mit
- Created: 2018-09-21T01:51:26.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2020-05-19T19:41:30.000Z (almost 5 years ago)
- Last Synced: 2025-03-29T08:32:51.538Z (about 1 month ago)
- Topics: aergo, lua-contract, package-manager
- Language: Java
- Homepage: https://aergoio.github.io/ship
- Size: 1.66 MB
- Stars: 11
- Watchers: 9
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://github.com/aergoio/ship)
[](https://travis-ci.org/aergoio/ship)
[](http://codecov.io/github/aergoio/ship?branch=master)
[](https://codeclimate.com/github/aergoio/ship/maintainability)
# Introduction
The ship makes your development rapid. It suggests the cycle to import, refer, and upload packages.
The ship provides the next:
* Initialize project
* Install package from github.com
* Build project
* Unit test project
* Publish to local repository
* Incremental build
* Deploy to aergo chain
* Runner to execute or query contract
## Modules
The repository contains next:
* core
* web
# Project structure
$USER_HOME/
+.aergo_modules/
$PROJECT_HOME/
| + xxxx/
+ aergo.json
* aergo.json - project description file
* .aergo_modules - modules to be downloaded by ship
## Command
* ship init
* ship install aergoio/athena-343
* ship build
* ship build --watch
* ship build --watch --port 8080
* ship test
* ship publish
# Configuration(aergo.json)
* name: project name
* source: source file to build
* target: result when you type 'ship build'
* dependencies: package dependencies
* tests: test cases to run
* endpoint: endpoint to deploy or run (Default value is "localhost:7845")
* privatekey: private key to deploy or execute contracts
* password: password to decrypt private key
## Examples
```json
{
"name": "bylee/examples",
"source": "src/main/lua/main.lua",
"target": "app.lua",
"dependencies": ["aergoio/athena-343"],
"test": ["src/test/lua/test-main.lua"],
"endpoint": "remotehost:7845"
}
```
# Integration
TBD
# Build
## Prerequisites
* [JDK 8](http://openjdk.java.net/)
* [NPM](https://www.npmjs.com/)
## Clone
```console
$ git clone https://github.com/aergoio/ship.git
```
## Build and package
* Clean
```console
$ ./build.sh clean
```
* Install deps
```console
$ ./build.sh deps
```
* Create ship web ui
```console
$ ./build.sh npm
```
* Run gradle
```console
$ ./build.sh gradle
```
if you use JDK 9 or over
```console
$ ./gradlew build -x test
```
* Assemble distributions
```console
$ ./build.sh assemble
```
# Test
## Kind of test
### Unit test
They are classes with 'Test' suffix.
### Integration test
They are classes with 'IT' suffix meaning integration test.
### Benchmark test
They are classes with 'Benchmark' suffix, which using jmh.
## Run tests
```console
$ ./build.sh test
```
# Documentation
We provides next in https://aergoio.github.io/ship
* JavaDoc
* Test Coverage
# Contribution