Skip to content
This repository has been archived by the owner on Jun 16, 2022. It is now read-only.

Latest commit

 

History

History
118 lines (79 loc) · 3.24 KB

README.md

File metadata and controls

118 lines (79 loc) · 3.24 KB
Raw

back-end-assignment-boilerplate

code style: prettier Commitizen friendly

Back end assignment boilerplate provides a starting point for solving tasks which are a part of the hiring process, so that it is easier and more efficient for candidates. It also gives a good indication of expectations and code style at Dott.

Usage

Use this repository as a template.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See usage notes on how to consume this package in your project.

Prerequisites

Minimal requirements to set up the project:

  • Node.js v10, installation instructions can be found on the official website, a recommended installation option is to use Node Version Manager. It can be installed in a few commands.
  • A package manager npm. All instructions in the documentation will follow the npm syntax.
  • Optionally a Git client.

Installing

Start by cloning the repository:

git clone [email protected]:ridedott/back-end-assignment-boilerplate.git

In case you don't have a git client, you can get the latest version directly by using this link and extracting the downloaded archive.

Go the the right directory and install dependencies:

cd back-end-assignment-boilerplate
npm install

That's it! You can now go to the next step.

Tests

All tests are being executed using Jest. All tests files live side-to-side with a source code and have a common suffix: .spec.ts. Some helper methods can be stored in the test directory.

There are three helper scripts to run tests in the most common scenarios:

npm run test
npm run test:watch
npm run test:coverage

Formatting

This project uses Prettier to automate formatting. All supported files are being reformatted in a pre-commit hook. You can also use one of the two scripts to validate and optionally fix all of the files:

npm run format
npm run format:fix

Linting

This project uses ESLint to enable static analysis. TypeScript files are linted using a custom configuration. You can use one of the following scripts to validate and optionally fix all of the files:

npm run lint
npm run lint:fix

Publishing

Content of this repository is not published to any package registry.

Contributing

See CONTRIBUTING.md.

Built with

Runtime libraries

Automation

Source

Delivery

Versioning

This project adheres to Semantic Versioning v2.