Code Monkey home page Code Monkey logo

runboaster's Introduction

Run Boaster

Where you can upload GPX files and have them charted, mapped and tabled.

Project structure

app directory = node.js and Express related code

public directory = angular.js related code

Testing uses Mocha and Superagent for the backend. Jasmine for TDD and Protractor for BDD, e2e tests.

The file structure uses a modular approach, based on features. Inside each module you'll find a test folder with the Jasmine specs for controller, services and directives.

In addition there is a e2etests module that houses the Protractor e2e tests.

Built using Mean.JS

Mean.js is a full-stack JavaScript open-source solution.

Before you begin we recommend you read about the basic building blocks that assemble a MEAN.JS application:

Prerequisites

Make sure you have installed all these prerequisites on your development machine.

  • Node.js - Download & Install Node.js and the npm package manager, if you encounter any problems, you can also use this Github Gist to install Node.js.
  • MongoDB - Download & Install MongoDB, and make sure it's running on the default port (27017).
  • Bower - You're going to use the Bower Package Manager to manage your front-end packages, in order to install it make sure you've installed Node.js and npm, then install bower globally using npm:
$ npm install -g bower
  • Grunt - You're going to use the Grunt Task Runner to automate your development process, in order to install it make sure you've installed Node.js and npm, then install grunt globally using npm:
$ sudo npm install -g grunt-cli

The first thing you should do is install the Node.js dependencies.

To install Node.js dependencies you're going to use npm again, in the application folder run this in the command-line:

$ npm install

This command does a few things:

  • First it will install the dependencies needed for the application to run.
  • If you're running in a development environment, it will then also install development dependencies needed for testing and running your application.

Next run bower

$ bower install

and run the grunt sass task to compile the sass into css.

$ grunt sass

Once this has finished you can start the default grunt task.

$ grunt

wait for the line

$ MEAN.JS application started on port 3000

Your application should run on the 3000 port so in your browser just go to http://localhost:3000

That's it! your application should be running by now.

This will be a clean install so you will have to add a new user and add their GPX files.

For the e2e tests you will also need to update an end user here too.

Create an end user. Add their GPX files. Then update their username and password in public/modules/e2etests/tasks/login.js

var login = {
  default : function () {
    loginPage.goto();
    loginPage.formUserName.sendKeys('wgreen');
    loginPage.formPwd.sendKeys('password');
    loginPage.formSubmit.click();
  }
};

Jasmine and server tests

grunt command to run the Jasmine, and server tests:

$ grunt test

Protractor tests

Follow the instructions on setup over at the [Protractor website] (http://angular.github.io/protractor/#/).

To run protractor

In one command terminal run

$ webdriver-manager start

and in another run

$ protractor protractor.conf.js

If you would like to run a single suite, such as the top nav, you can run

$ protractor protractor.conf.js --suite uploadPage

The suites are set up in the protractor.conf.js file

License

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

runboaster's People

Contributors

amenders avatar amoshaviv avatar andrunix avatar ar1g avatar ariutta avatar bwestmoreland avatar claydiffrient avatar cpacker avatar dizda avatar enkodellc avatar fyockm avatar jonaswindey avatar liorkesos avatar lirantal avatar luebken avatar mackstar avatar memolog avatar michaeljcole avatar mrjasonweaver avatar mrngoitall avatar netusco avatar pontifier avatar rapind avatar revdave33 avatar rschwabco avatar shacharz avatar spacemonkey avatar thehashrocket avatar vikramtiwari avatar warreng avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.