1. General Development Guide for Monorepo

Introduction

This wiki will guide you to get quickly get started with development

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

node

https://nodejs.org/dist/v10.15.3/node-v10.15.3.pkg

yarn (package manager)

brew install yarn

TypeScript (tsc command)

npm install -g typescript

Installing

git clone https://github.com/TracerBench/tracerbench.git
cd tracerbench/
yarn install

#TODO sample output

Running the tests

#TODO

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

Packages to Note

lerna is used as the monorepo manager

Project Structure

There are 4 subprojects within this monorepo (linked are their own development wikis)

• cli - The web framework used
• tracerbench - A web application benchmarking tool providing clear, usable insights for performance regressions with continuous integration hooks
• har-remix - HAR-Remix allows the offline serving of HTTP Archive (HAR) files.
• har - Provides typing to parsed JSON from a HAR archive.

Contributing

#TODO

Versioning

Lock step mention? #TODO

Authors

#TODO

License

#TODO