fusionalliance/starter-kit

Standards

Fusion Starter Kit

Enforcing a consistent approach to start up new projects at Fusion Alliance.

Table of Contents

• Objectives
• Features
• Roadmap
• Requirements
• Usage
• FAQ
• Contributing
• License

Objectives

• Maintain consistent tooling across projects
• Enforce standards
• Accelerate project start-up
• Outline delivery quality processes

Features

• Quick creation site boilerplates using several different frameworks.
• Code formatting enforced with EditorConfig
• JS linting with ESLint + AirBnB
• Sass (SCSS) + Stylelint > CSS
• Markdown linting
• Delivery quality processes + templates

Roadmap

A separate Roadmap doc has been created to manage the phases of development on this starter kit.

Requirements

• A code editor that supports EditorConfig, or install the EditorConfig extension for you code editor

Usage

Local starter kit development

1. Clone the starter-kit repo to your machine.
2. In the fusion starter-kit repo run npm link. This will create a global link to your local files.
3. You can now run fusion-starter-kit in the command line to run the package.
4. The starter kit will ask you which framework you would like to use - select one
   • Answer any additional prompts
   • Wait for it to finish running
5. Run npm install
6. Your project is now ready to go. You can run it with npm run dev

As a package

TODO: Package needs to be on npm or something

Scripts

• Install server and website: npm install
• Develop locally: npm run dev
• Build: npm run build
• Watch for lint: npm run dev
• Run tests: npm test

SCSS

• Uses the The 7-1 Pattern for architecture
• Generally follows Sass Guidelines for code style
• See the SCSS README for more information

FAQ

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT For more information see LICENSE