bardog-frontend v0.0.1

Bardog - Frontend

Getting Started

This is the Frontend project for BarDog. To setup the development environment follow the steps below:

Prerequisites and installation

• The project is based in the React Slingshot project. Therefore in order to install the project, please complete its Initial Machine Setup.
• To install the dependencies, run:

  npm install

Directories structure

The main directories are:

• src - source files
  • components - UI generic components, like Buttons, Table
  • pages - View pages, like Audit, Vendors, etc
  • state - State modules, like Audits, User and Business

NPM Scripts

• setup - runs a node script to install the project
• start - starts the dev environment
• build - builds the project for production
• docs:build - builds the documentation

Configuring the DOCS

ESDocs

• The Styleguidist generates the general docs.
• The configuration is in the ./esdoc.json file.

Styleguidist

• The Styleguidist generates the Components docs.
• The configuration is in the ./styleguide.config.js file.

References

Generic

• Return functions - Simplyfing arrow functions
• Sublime Text Comment Snippets