Giter VIP home page Giter VIP logo

always-be-running's Introduction

AlwaysBeRunning.net (ABR)

Installation (Linux/Mac)

You will need the following in order to run ABR locally:

  • MySQL (preferably)
  • PHP
  • PHP Composer
  • Node, NPM
  • JQ - download via apt-get (Debian) or homebrew (Mac), this is NOT an npm module
  • imagemagick
  1. Clone ABR from GitHub

  2. Install npm dependencies, install npm gulp globally

     npm install
     npm install -g gulp
    
  3. Install PHP dependencies

     php composer.phar install
    
  4. Run gulp to prepare assets (do this every time if you change JS or CSS)

     gulp
    
  5. Configure the settings of your local environment. Rename the .example.env file to .env. Edit the DB settings to connect to your locally running DB. Ask the main dev (madarasz / Necro) for NetrunnerDB keys. Google API keys, you can create yourself.

  6. Prepare ID icons by running this script (downloads from NetrunnerDB, run it regularly)

     ./get_id_images.sh
    
  7. Prepare DB tables

     php artisan migrate
     php artisan db:seed
    
  8. Run the webapp. It should be available at http://localhost:8000 afterwards.

     php artisan serve
    
  9. Make yourself an admin. Go to the webapp in your browser. Login via NetrunnerDB to enter your user in the DB. Check your DB (use phpMyAdmin), in table users set the admin value of your user to 1. If you reload the webapp you should see the Admin section in the top menu.

  10. Download all the data required from NetrunnerDB. Go to Admin section and click the Update Card cycles, Update Card packs and Update Identities buttons to get the data. Do this every time a new pack comes out.

  11. You are done :)

Automated tests

There are Nightwatch automated integration tests in the tests/nightwatch directory.

Run Nightwatch tests on Chrome by command:

    gulp nightwatch:chrome

There are currently problems with running tests on PhantomJS and Safari Safari browser must be enabled for automation, [https://webkit.org/blog/6900/webdriver-support-in-safari-10/](read more)

always-be-running's People

Contributors

d2cqa-madarasz avatar madarasz avatar phette23 avatar x3n1gm4x avatar

Watchers

 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.