Skip to content

jagatjeevan/react-setup

Repository files navigation

dependencies Status devDependencies Status

React setup

A sample project for a React project

Installation Guide

Dependency
  • Node : Make sure you are on 6.11.1 version.
Tech Stack
  • Yarn : Node package manager
  • Webpack : The module bundler
  • Sass : Css Pre-processor
  • Sass Linter : Style consistency
  • Es6 : Better way to write JavaScript.
  • Es6 Linter : JavaScript Consistentency and best practices
  • nsp : Checks the node modules vulnerabilities
  • React
  • Redux : state management
  • Translation : i18next
Running the module
  • Check if you are running the right version of node. Check ".nvmrc" or "package.json"
  • yarn install
  • yarn start
    Check for other options in package.json, script section.

Some Practices followed

Git Commit message
  • Write crisp commit message. Details should be in the code and not the message.
  • Format : JiraCard | Message | Pair1/Pair2
  • There are pre-commit hooks. Please try not to push with --no-verify option.
Component Names
  • Component names are Sentence case. App, Dashboard, etc.
  • Rest are camel case.
Fixme
  • Yarn deletes the .yml file required for sasslint. Hence not using yarn
  • Translation does not refresh the labels. It has to be manually refreshed