Skip to content

3. Tracerbench Development Guide

Steven Pham edited this page Apr 24, 2019 · 2 revisions

Introduction

This wiki will get you up to speed with how tracerbench (the subproject) is structured and guide you in setting up the subproject

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You should've already installed the requirements for the monorepo. If you have not, refer to this wiki.

Installing

At the root of the tracerbench monorepo folder

cd packages/tracerbench/
tsc -b tsconfig.json

#TODO how to know you successfully built

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Built With

  • chrome-debugging-client - An async/await friendly Chrome debugging client with TypeScript support, designed with automation in mind. Tracerbench code uses this to interface with chrome headless. API documentation website located here

Contributing

#TODO

Versioning

Lock step mention? #TODO

Authors

#TODO

License

#TODO