L2Y21-AABRDP-simple-blockchain

Rules of repo

Branching strategy

We use GitHub Flow.

Commit message format

Our convention for commit messages:

feat: Add beta sequence
^--^ ^---------------^
| |
| +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

We use tools: Commitlint and Husky.

Convention for code

For this purpose we use ESLint AirBnb style guide. Why Use AirBnB’s ESLint Configuration? A Review of AirBnB’s Rules List.

How to use after clone (make sure to clone 'main' branch)

1. Install packages

   npm install

2. Run

   npm start

   For testing API endpoinst go to /api-docs. We use Swagger. For code documentation run docs/index.html. We use ESDoc.

3. Test

   npm test

4. Before commit ESLint will check your code and problems will come out if there are any. However, you can check or fix your code at any time with:

   • ESLint check:

     npm run lint

   • ESLint fix:

     npm run lint-fix