made-style-guide v0.0.3
Made Code Style Guide
This is the Made Code Style Guide and component library
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisities
- This project runs in a NodeJS runtime you would likely need to be running an environment with Node(7.10.0) and above.
Installing
- checkout the project or get a zip
git checkout https://github.com/madeagency/made-code-website.git
- Install dependecies using yarn or npm
yarn install
or
npm install
- Run the development server to in watch mode and begin hacking
yarn dev
or
npm dev
Running the tests
To run unit project tests we use jest as a test runner and test files will have the .test extension
Run tests using
yarn test
or
npm test
Run tests in watch mode to watch your back as you hack run
yarn test:watch
or
npm test:watch
Break down into end to end tests
This will be updated
Built With
- Webpack Module Bundler
- React
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Zacck Osiemo - Zacck
See also the list of contributors who participated in this project.
LICENSE
Maintained by
Made Style Guide was created and is maintained MADE Agency PTY Ltd. The names and logos for MADE Code are trademarks of MADE Code PTY Ltd.
We love open source software. See our Github Profile for more.
We're always looking for talented people who love programming. Get in touch with us.