https://github.com/dickwyn/safedevils

Simple safety web app
https://github.com/dickwyn/safedevils

nodejs pug safetrek-api sass

Last synced: about 1 month ago
JSON representation

Simple safety web app

• Host: GitHub
• URL: https://github.com/dickwyn/safedevils
• Owner: dickwyn
• License: mit
• Created: 2018-05-26T05:28:04.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-27T02:31:37.000Z (over 6 years ago)
• Last Synced: 2024-10-26T04:53:40.162Z (3 months ago)
• Topics: nodejs, pug, safetrek-api, sass
• Language: JavaScript
• Homepage: http://safedevils.dickwyn.xyz/
• Size: 896 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## testorange safe

testorange-safe application. Built with the Noonlight (formerly SafeTrek) API

## Project Dependencies

This project is built with:

1. SafeTrek

2. [NodeJS](http://nodejs.org)

4. [GulpJS](https://gulpjs.com/) - `$ npm install gulp-cli -g`

5. [PugJS](https://pugjs.org/api/getting-started.html) - `$ npm install pug`

## Running the Project

**Get Started**

1. Clone or download this repository

2. `$ npm install` on the directory

**Development Mode**

1. `$ npm start`

2. Browsersync can be accessed through `localhost:3000`

## Folder Structure

    .  

    ├── public              # All additional assets of the projects

    │   ├── assets          # All media assets

    │   ├── scripts         # Compiled.js files    

    │   └── └── src         # All unprocessed .js files

    │   ├── styles          # Processed .css files

    │   └── └── src         # All unprocessed .scss files

    ├── .gitattributes

    ├── .gitignore          # Folders and files that are ignored by git

    ├── Procfile            # Defininition for heroku deployment

    ├── README.md           # Readme file for repository

    ├── app.json            # Folders and files that are ignored by git

    ├── gulpfile.babel.js   # Automate compilation

    ├── index.js            # main entry point

    ├── package-lock.json

    └── package.json        # Document node dependencies

## License

The contents of this repository are covered under the [MIT License](https://github.com/dickwyn/testorange-safe/blob/master/LICENSE).