Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 3.12 KB

README.md

File metadata and controls

86 lines (59 loc) · 3.12 KB
Raw

NEM Community Client (NCC)

NCC is the initial client provided with NEM. It provides a web interface for managing wallets and interacting with the NEM Infrastructure Server (NIS).

NCC Packages

There are two NCC maven packages:

  • nem-client-api: Contains all NCC functionality as well as the web UX.
  • nem-client-download: Used by WebStart to download NCC and NIS.

If the maven goal "install" is processed, a JNLP file is generated, all dependent libs are signed with the self-signed certificate which is included in the project. This will be replaced by an official CA-authority certificate in the near future.

Building

nem.core is required to build NCC. Most recent version, can be found here nem.core documentation can be found here

Running NCC Locally

In order to run the client with full functionality, a NEM Infrastructure Server (NIS) instance should be running on the local machine.

The NCC client can be started by running the org.nem.core.deploy.CommonStarter class.

For debugging purposes, it is recommended to turn off WebStart functionality by setting nem.isWebStart to false in the config.properties file.

NCC REST API

The original version of the NCC REST API can be found here.

Unfortunately, the API documentation is out of date.

Generating JavaDoc Documentation

The javadoc documentation can be created via the maven goal "javadoc:javadoc" on the project "nem-client-api".

Pull Requests

NCC is fully open-sourced and looking for contributors. Please take a fork and add a feature :).

The NEM core development team will be managing pull requests into master. Please try to follow the guidelines outlined here.

Coding Guidelines

Please use the intellij settings checked in under settings/nem_project_settings.jar. A non-comprehensive list of style guidelines follow, but the checked in settings should take precedence.

Member Naming

  • Use lowerCamelCase.
  • Prefix booleans with "is" / "has" / "are".
  • Precede access of instance members with "this.".
  • Camel case acronyms at least three letters (i.e. prefer "Nis" to "NIS").

Braces

  • Always use braces (even for single line statement bodies).
  • Follow '}' with a blank line.
  • Do not precede '}' with a blank line.

Imports

  • Wildcard import package if more than one class is used from a package.
  • Sort imports alphabetically.

Documentation

  • Document all public and protected members.
  • Getter documentation should start with "Gets".
  • All documentation should start with capital letter and end with period (for members documentation too).

Unit Tests

  • Try to avoid testing composite classes.
  • Use Act / Arrange / Assert.

Other

  • Use the final keyword aggressively.
  • Avoid the use of trailing whitespace.
  • Keep functions short and understandable :).
  • Do not introduce consecutive blank lines.