Giter VIP home page Giter VIP logo

warframe-hub's Introduction

Warframe Hub

Build Status Codacy Badge Waffle.io - Columns and their card count

Supported by Warframe Community Developers

Prerequisite

In order to run your own version of Warframe Hub, you are required to have the following on your machine:

  • Node 8.x for running the project
  • NPM 5.x for dependency control, usually installed with Node.js

Dependencies

Most software related dependencies should be managed by NPM, and will be automatically installed when you try to run the project. We'll cover those dependencies in the following section.

Warframe Hub also relies on the availability of the internet, as it will parse the Warframe WorldState. It uses a slightly easier to parse WorldState provided by Warframe Stat

Installation

Clone or download and unpack this repository. Install the dependencies using NPM

$ npm install

If everything goes well, it should tell you the number of packages it has installed. Then you can try to run it and hope everything goes well.

$ npm start

The express website should be accessible at http://localhost:3000

Bug/Issue Report

Found a bug or an issue? Please submit a bug/issue report under the issue tab.

Testing

Our builds goes through Travis-CI's tester.

You can see the latest results here or by clicking on the badge at the top of the page.

The repo also includes a mocha script that is used for Travi CI's unit testing. You can run this manually by installing mocha first globally on your machine, then run the specifications named mochaspec.js

$ npm install -g mocha
$ mocha spec mochaspec.js

Another things that's very helpful for development is nodemon. This will automatically restart the express server if any changes is detected in the project folder. No more restarting the node server manually! Just run it in the project directory and it should take care of the rest.

$ npm install -g nodemon
$ nodemon

License

The distribution of this software is protected under Apache License 2.0

Small Note

Like most projects, Warframe Hub is purely out of passion, love, and dedication to the Warframe Community and open source software in general. This is not my full time job, and probably will never be. No donations will be encouraged because once a person starts to receive payments for a passion project, is it still a passion?

warframe-hub's People

Contributors

ericsihaolin avatar tobitenno avatar stickler-ci 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.