Skip to content

danechitoaie/sfra-webpack-setup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b8ccf82 · May 1, 2020

History

8 Commits
Dec 2, 2018
Dec 2, 2018
Dec 2, 2018
Dec 2, 2018
Jun 26, 2019
Dec 2, 2018
Jun 26, 2019
Dec 2, 2018
Dec 2, 2018
Jun 26, 2019
May 1, 2020
Dec 2, 2018
May 1, 2020

Repository files navigation

Project Name

Project Structure

Requirements

  1. NodeJS version >=8.14.0 (to install and manage NodeJS see https://github.com/coreybutler/nvm-windows for Windows or https://github.com/creationix/nvm for MacOS/Linux)
  2. Yarn (install it globally with npm install --global yarn)

Getting Started

  1. Clone this repository
  2. Run yarn install to install all of the local dependancies
  3. Run yarn run webpack:dev to start watching for file changes and compile JS and SCSS files when that happens
  4. Run yarn run lint to run all the code linters or run:
    • yarn run lint:js-server to run only the server side JS linter
    • yarn run lint:js-client to run only the client side JS linter
    • yarn run lint:scss to run only the SCSS linter

Recommended tools

Visual Studio Code is recommended to be used along with the following plugins:

  1. SonarLint - To help you detect and fix quality issues as you write code. Like a spell checker, SonarLint squiggles flaws so they can be fixed before committing code.
  2. Prettier - To help you easily format and prettify your code (make sure you set "prettier.tabWidth": 4 before you start using it)
  3. Document This - To help you with writing JSDoc for your code
    • CMD + Shift + P -> Format Document
    • Select the text you want to Prettify and CMD + Shift + P -> Format Selection
  4. Path Intellisense - To help you autocomplete paths and filenames
  5. vscode-icons - To make your VSC explorer a bit nicer

Submitting a pull request

  1. Create a feature branch from the develop branch (feature/TASK-NR)
  2. Make sure all your comits have proper commit message ([TASK-NR] Commit description)
  3. When creating your pull reqeust make sure it has:
    • A proper title (use the following naming convention [TASK-NR] Pull request title)
    • A brief description of what the pull request does
    • (optional) Screen shots
  4. Your code should pass the automation process:
    • Lint your code: yarn run lint should run withouth errors
    • Build your code: yarn run webpack:dev should run withouth errors

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published