https://github.com/rangle/augury-site
Augury's Documentation Site
https://github.com/rangle/augury-site
Last synced: about 1 year ago
JSON representation
Augury's Documentation Site
- Host: GitHub
- URL: https://github.com/rangle/augury-site
- Owner: rangle
- License: other
- Created: 2016-05-09T15:13:08.000Z (about 10 years ago)
- Default Branch: staging
- Last Pushed: 2022-12-08T00:48:57.000Z (over 3 years ago)
- Last Synced: 2025-03-24T14:13:03.089Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://augury.rangle.io/
- Size: 28.7 MB
- Stars: 3
- Watchers: 10
- Forks: 7
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: license.html
Awesome Lists containing this project
README
# Prerequisites
- Node 6
- NPM
Make sure you have the latest npm installed.
```bash
npm install npm@latest -g
```
# Development
```bash
npm install
npm run custom-install
npm start
```
This will install material-design-lite into your source folder, this dependency is needed to create a clean build. Managing it from the node_modules folder is not possible, since harp does not parse that folder.
```bash
npm start
```
# Production
Before you push to production, make sure to test the build from staging area. To do this, perform a production build as shown below. The compiled code will be placed under the wwww folder.
```bash
./build.sh
```
Once you've tested the production build in staging, you may push deploy to production by doing a PR to
the `production` branch.
# Deployment flow
- Always open pull requests to the staging branch (PR's to the master branch will be denied)
- All PR's will be verified and tested on staging once accepted.
- Master releases are done if staging changes are accepted by Augury team members
- All releases will be versioned.