Skip to content

README.md

Latest commit

 

History

History
48 lines (30 loc) · 1.42 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.42 KB

Ooly Web

Requirements

Setup

The project is using node and some npm packages, to install some packages like Webpack.

Commands

Command Description
npm run dev Start the development environment
npm run build Build the projects and compile source files

URLs

Once you run Webpack development server is running, this URLs become available:

URL
http://localhost:9001

Coding guidelines

Git

We use Gitflow as our Git workflow. More explanation here.

Code style & format

Styles

  • We use Prettier (https://prettier.io/) as code formatting tool. The configuration is written in .prettierrc at the root of the project. You must NOT edit this file.
  • We use 2 (two) spaces for indentation.

Naming

  • We use camelCase for variables, properties, functions and methods.
  • We use PascalCase for classes.

Rules

Before pushing code, please make sure to :

  • Include unit tests to test every function you've added.
  • Add comments, and regenerate the documentation : npm run api.
  • Clean and refactor code.