Development Getting Started

This is the getting started guide for development. If you're interested in benchmarking please visit the getting started guide for benchmarking.

1. Get TFB
   • Fork the TFB project to your own repository.
   • Clone your TFB repository to your local environment to get started.
2. Set up a development environment
   • We strongly recommended that you set up your TFB environment in a virtual machine or on a remote server dedicated to this project, as the suite adds users with escalated privileges, requires most ports to be open, installs system software, and may uninstall or reinstall software that you already have. Our production environments use 3 separate servers to run the database, the load-generation system, and the web framework itself, but since you are getting set up for development, you can run all 3 on a single machine.
   • Get started quickly and set up your development environment with vagrant, or
   • Click here for the guide to get your development environment set up. Note: We provide scripts for configuring a Linux development environment using either Virtualbox or Amazon EC2, and are actively searching for help adding Windows.
3. Use GitHub Actions
   • Use GitHub Actions on your project fork. Any commits you send to Github are automatically verified for correctness (e.g. meeting all benchmark requirements).
4. Run a Test
   • tfb --mode verify --test ${your-test-here} - to verify that your test works.
   • tfb --mode debug --test ${your-test-here} - will just spin up your server, allowing you time to debug the endpoints.
5. Clean Up
   • Remove the contents of /FrameworkBenchmarks/installs/ if you'd like to re-install the framework dependencies.
     • You can remove the results/ and installs directories by adding the --clean-all option to the run-tests.py command