Camping St-Pie

Hébergement et Événementiel

---

Table of Contents

• Table of Contents
• How to use
  • Install
  • Lint
  • Format
  • Test
  • Build
  • Start
  • Analyze
  • Commit
  • Check
• Development
  • Profile
  • Structure

How to use

Here is the list of scripts for the project that should be used in this specific order.

Install

• Clone the repository.

git clone https://github.com/Parapluieinfo/CampingStPie.git

• Install the dependencies.

npm install

Lint

• Lint everything in the project

npm run lint

• Lint JavaScript

npm run lint:js

• Lint Markdown

npm run lint:markdown

• Lint Markup

npm run lint:markup

• Lint Styles

npm run lint:styles

• Lint YAML

npm run lint:yaml

Format

• Check the formatting in the project

npm run format:check

• Format everything in the project

npm run format:fix

Test

• TBA

Build

• Build both client and server

npm run build

• Build client

npm run build:client

• Build server

npm run build:server

Start

• Start both client and server

npm run start

• Start client

npm run start:client

• Start server

npm run start:server

Analyze

• Analyze dependencies with Webpack

npm run analyze

Commit

• Commit changes to the project (see Commit Convention)

npm run commit

Check

• Check code before pushing to Github. (lint, build & test)

npm run check

Development

Profile

You can use the NodeJS profile in the .vscode directory.

1. Press CTRL + SHIFT + P
2. Type & Select import profile
3. Select Select File...
4. Use the file NodeJS.code-profile in the .vscode directory
5. Click the button Create Profile
6. Name the profile e.g. NodeJS
7. Press the button Create

Structure

• src
  • client
    • files
    • images
    • scripts
    • styles
    • templates
  • server