Code Monkey home page Code Monkey logo

taskcluster-tools's Introduction

TaskCluster Tools

This repository contains a collection of useful tools for use with TaskCluster. Generally, we strive to not add UI to TaskCluster components, but instead offer well documented APIs that can be easily consumed using a client library for TaskCluster. See TaskCluster documentation site for details.

Developing TaskCluster Tools

Prerequisites for building TaskCluster Tools

  • Node version v6+

Building

git clone https://github.com/taskcluster/taskcluster-tools.git
cd taskcluster-tools
npm install

Code Organization

  • src/ (Tools source code)
  • src/<app>/ (application specific-code, can be reused)

Tasks and Configuration

Building this project uses neutrino, neutrino-preset-react, and the src/tools-preset to:

  • Compile ES2015+ syntax to ES5-compatible JS
  • Compile React JSX to de-sugared JS
  • Show ESLint errors during development, and both errors and warnings when building
  • Build application directories into page-specific bundles
  • LESS files to CSS

Testing changes

Install npm dependencies and start it up:

  • npm install
  • npm start

This will start a local development server on port 9000 (http://localhost:9000).

Any ESLint errors across the project will be displayed in the terminal during development.

Available targets

  • npm start: the default development build, watches src/, and serves on http://localhost:9000/
  • npm run build: builds src/ into a build/ directory

Memory problems during development

It's possible that when building a larger project like taskcluster-tools that Node.js will run out of memory for the amount of files being built during development. As a workaround, instead of running npm start, run the following to run the same command with more memory:

PORT=9000 node --max-old-space-size=4096 node_modules/.bin/neutrino start -p tools-preset

Testing

Until someone comes up with something better, which probably involves Redux or similar, all testing is manual. Open the tools and check that they work. :)

Ngrok Setup (optional)

Ngrok allows you to expose a web server running on your local machine to the internet. Ngrok is used creating an https connection, so that you can login to the taskcluster-tools. For using ngrok:

  • Create an account (free) on ngrok.
  • Install ngrok - npm install ngrok
  • Run ngrok - ngrok http 9000

Note: You have to run ngrok in a separate terminal/console.

taskcluster-tools's People

Contributors

jonasfj avatar djmitche avatar jhford avatar eliperelman avatar acmiyaguchi avatar andreadelrio avatar imbstack avatar gregarndt avatar petemoore avatar walac avatar eggylv999 avatar garbas avatar helfi92 avatar ckousik avatar techchic avatar aholachek avatar armenzg avatar elena-posea avatar anarute avatar reznord avatar lightsofapollo avatar kristelteng avatar mshal avatar chinhodado avatar owlishdeveloper avatar

Watchers

James Cloos avatar Diksha Bhateja 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.