Skip to content

didier/team

Repository files navigation

Blind — Modern Blind Dating

A dating app assignment for @cmda-bt Blok Tech with @max-hauser, @sybrenmolenaar, @zoeseveriens and @didiercatz

Installing

$ git clone https://github.com/didiercatz/team.git
$ npm install # or yarn

Running the server

$ npm run start # or yarn start

Running the server in development mode

$ npm run dev # or yarn dev

Running the server in debug mode

This mode logs extra information to the console everytime a CRUD operation is performed.

$ npm run debug # or yarn debug

Generating documentation with JSDoc

outputs to ./docs

$ npm run docs # or yarn docs

Conventions

This projects uses prettier, eslint and stylelint. Be sure to install those in your editor, or run their respective scripts.

Boolean variables are to be prepended with either is or has, e.g.:

const isLoggedIn = true;
const hasUserLoggedIn = true;

Linting and Formatting

ESLint

ESLint is a JavaScript (EcmaScript) linter that shows you errors as you write your code.

Prettier

Prettier is a formatter for HTML, CSS and JS that automatically makes your code, well, prettier. It formats based on your settings for indentation, bracket location, semicolons, etc. It's configured to listen to ESLint's config as well.

Sources