Skip to content

A NPM powered frontend framework for web projects.

License

Notifications You must be signed in to change notification settings

dellow/Web-Framework

Repository files navigation

Web Framework Readme

Dependency Status JavaScript Style Guide

Contents

  1. About
  2. Requirements
  3. Install
  4. Changelog

About

This is a fast Framework and/or Project Wrapper and workflow for web projects that utilises Webpack as a build tool.

Requirements

The only system requirement is Node & NPM.

Please note: This should be installed before using this Framework.

Install

Please make sure your system meets the requirements above.

Git

You can get Web Framework by cloning this repository simply by running git clone [email protected]:sdellow/web-framework.git.

Init

Once complete simply run bash commands/install.sh from your command line. This will do the following:

  • Remove the Git wrapper and replace with a fresh Git initialisation.
  • Remove any un-necessary files/directories.
  • Get all Bower dependencies.
  • Get all NPM dependencies.
  • Does an initial commit on the new Git initialisation.

All additional instructions below assume you have followed the installation process.

Pro Tip: You can make the install script executable by running chmod u+x commands/install.sh. This will allow you to run the script like this: ./commands/install.sh.

Changelog

See the main Changelog for entries.