Open-Wifi

Version 1.0 01/05/2016 CURRENTLY UNDER CONSTRUCTION

What Is It?

The world is full of unused, vacant or spare WiFi. Rent stress-free wifi from people near you. It beats dealing with ISP's

This repo holds the source code for Open-Wifi. A community marketplace where people can list, discover, and rent WiFi signal, TO or FROM, others living nearby! Whether its your neighbors or your roomate/s it can help bring down the cost of your monthly internet bill or help you avoid dealing with those lovely Internet Service Providers....and that's the truth.

While the developers of this project want to keep this app small, we are eager to maintin a robust, collaborative, open-source code base.

Requirements

Installation

If you would like to contribute to our project please fork this repository or clone it down locally using the GitHub clone link provided. All pull requests will be reviewed by our team and we'll reach out to you if we'd like to incorporate your work. :)

Quickstart

Once you have the repo in your local machine simply run the following commands:

run npm install to install the required dependencies and devdependencies.
run bower install to install bower
run gulp serve to launch a browser sync server on your source files
run gulp test to run your unit tests with Karma in watch mode

Directory Structure

At the moment this is highly subject to change but will updated regularly.

├── app
│   ├── components
│   │   ├── githubContributor
│   │   │   ├── githubContributor.service.js
│   │   │   └── githubContributor.service.spec.js
│   │   ├── malarkey
│   │   │   ├── malarkey.directive.js
│   │   │   └── malarkey.directive.spec.js
│   │   ├── navbar
│   │   │   ├── navbar.directive.js
│   │   │   └── navbar.directive.spec.js
│   │   └── webDevTec
│   │       ├── webDevTec.service.js
│   │       └── webDevTec.service.spec.js
│   ├── index.config.js
│   ├── index.constants.js
│   ├── index.module.js
│   ├── index.route.js
│   ├── index.run.js
│   ├── index.scss
│   ├── main
│   │   ├── main.controller.js
│   │   └── main.controller.spec.js
│   ├── stylesheets
│   │   ├── Partials
│   │   │   ├── malarkey.scss
│   │   │   └── navbar.scss
│   │   └── home.scss
│   └── views
│       ├── pages
│       │   └── home.html
│       └── partials
│           └── navbar.html
├── assets
│   └── images
│       ├── angular.png
│       ├── browsersync.png
│       ├── gulp.png
│       ├── jade.png
│       ├── jasmine.png
│       ├── karma.png
│       ├── node-sass.png
│       ├── protractor.png
│       └── yeoman.png
├── favicon.ico
└── index.html

Development Server

Our source code includes the awesome gulp-plugin BrowserSync as the development server.

This allows you to serve your web resources locally to be more reactive and be able to have features like automatic reload of your page when you make a modification.

Live Reload Of Sources

When you launch your dev server with gulp serve, it will launch BrowserSync along with the file watching and pre-processing feature.

When gulp detects a change, it will send a reload command to Browser Sync. Depending on which files have changed (html/js or css) it will reload the whole page or just reload the css and keep your page context up.

Developer User Guide

A closer look at the features present in the source code for contributors

MarcZenn/Open-Wifi