Start your next eveble project in seconds

Eveble dedicated development environment for building fast, robust projects or framework extensions(i.e. dependencies) with best industry standard practices in places

Requirements

• Node.js MUST be v14.0 or later.

Quick start

# Clone the repository
$ git clone https://github.com/eveble/eveble-boilerplate.git <YOUR_PROJECT_NAME>
# Go into the repository
$ cd <YOUR_PROJECT_NAME>
# Run setup
$ npm run setup

1. Setup script will install dependencies, clean the template for new project and set new project details. Please remember to define homepage url during setup that MUST be pointing to the documentation on Github Pages: https://_username_.github.io/_package-name_/

2. Set Github repository Secrets for Github Actions:

• NPM_TOKEN - Secret generated in npm's Auth Tokens
• PROJECT_KEY_PATTERN - Pattern matching project key used by issue tracking software(i.e. like FOO-13), for example:

[a-zA-Z0-9_]{3}-[\d]+

• TICKET_URL - URL that points out to issue tracking software like: https://jira.yourdomain.com/browse/

5. Ensure that branch gh-pages is set for Github Pages.
6. Ensure that LICENSE file is updated to appropriate one.
7. Ensure that private projects are not released publicly by accident.

Now what?

If you're curious to learn more about template, continue on to the best practices.

Please note that the current state of documentation is not meant for beginners. It will be improved in next revisions.