|
@@ -9,31 +9,24 @@ If you're new to the project, welcome! Please feel free to ask questions [here](
|
|
|
|
|
|
This project provides representative performance measures across a wide field of web application frameworks. With much help from the community, coverage is quite broad and we are happy to broaden it further with contributions. The project presently includes frameworks on many languages including `Go`, `Python`, `Java`, `Ruby`, `PHP`, `C#`, `Clojure`, `Groovy`, `Dart`, `JavaScript`, `Erlang`, `Haskell`, `Scala`, `Perl`, `Lua`, `C`, and others. The current tests exercise plaintext responses, JSON seralization, database reads and writes via the object-relational mapper (ORM), collections, sorting, server-side templates, and XSS counter-measures. Future tests will exercise other components and greater computation.
|
|
This project provides representative performance measures across a wide field of web application frameworks. With much help from the community, coverage is quite broad and we are happy to broaden it further with contributions. The project presently includes frameworks on many languages including `Go`, `Python`, `Java`, `Ruby`, `PHP`, `C#`, `Clojure`, `Groovy`, `Dart`, `JavaScript`, `Erlang`, `Haskell`, `Scala`, `Perl`, `Lua`, `C`, and others. The current tests exercise plaintext responses, JSON seralization, database reads and writes via the object-relational mapper (ORM), collections, sorting, server-side templates, and XSS counter-measures. Future tests will exercise other components and greater computation.
|
|
|
|
|
|
-[Read more and see the results of our tests on Amazon EC2 and physical hardware](http://www.techempower.com/benchmarks/).
|
|
|
|
-For descriptions of the test types that we run, see the
|
|
|
|
|
|
+[Read more and see the results of our tests on cloud and physical hardware](http://www.techempower.com/benchmarks/). For descriptions of the test types that we run, see the
|
|
[test requirements section](https://frameworkbenchmarks.readthedocs.org/en/latest/Project-Information/Framework-Tests/).
|
|
[test requirements section](https://frameworkbenchmarks.readthedocs.org/en/latest/Project-Information/Framework-Tests/).
|
|
|
|
|
|
If you find yourself in a directory or file that you're not sure what the purpose is, checkout our [file structure](http://frameworkbenchmarks.readthedocs.org/en/latest/Codebase/#file-structure) in our documenation, which will briefly explain the use of relevant directories and files.
|
|
If you find yourself in a directory or file that you're not sure what the purpose is, checkout our [file structure](http://frameworkbenchmarks.readthedocs.org/en/latest/Codebase/#file-structure) in our documenation, which will briefly explain the use of relevant directories and files.
|
|
|
|
|
|
## Quick Start Guide
|
|
## Quick Start Guide
|
|
|
|
|
|
-Get started developing quickly by utilizing vagrant with TFB. [Git](https://git-scm.com),
|
|
|
|
-[Virtualbox](https://www.virtualbox.org/) and [vagrant](https://www.vagrantup.com/) are
|
|
|
|
-required.
|
|
|
|
|
|
+To get started developing you'll need to install [docker](https://docs.docker.com/install/) or see our [Quick Start Guide using vagrant](.#quick-start-guide-(vagrant))
|
|
|
|
|
|
1. Clone TFB.
|
|
1. Clone TFB.
|
|
|
|
|
|
$ git clone https://github.com/TechEmpower/FrameworkBenchmarks.git
|
|
$ git clone https://github.com/TechEmpower/FrameworkBenchmarks.git
|
|
|
|
|
|
-2. Change directories
|
|
|
|
-
|
|
|
|
- $ cd FrameworkBenchmarks/deployment/vagrant
|
|
|
|
-
|
|
|
|
-3. Create the TFB Docker virtual network
|
|
|
|
|
|
+2. Create the TFB Docker virtual network
|
|
|
|
|
|
$ docker network create tfb
|
|
$ docker network create tfb
|
|
|
|
|
|
-4. Run a test.
|
|
|
|
|
|
+3. Run a test.
|
|
|
|
|
|
$ docker run -it --network=tfb -v /var/run/docker.sock:/var/run/docker.sock --mount type=bind,source=[ABS PATH TO THIS DIR],target=/FrameworkBenchmarks techempower/tfb --mode verify --test gemini
|
|
$ docker run -it --network=tfb -v /var/run/docker.sock:/var/run/docker.sock --mount type=bind,source=[ABS PATH TO THIS DIR],target=/FrameworkBenchmarks techempower/tfb --mode verify --test gemini
|
|
|
|
|
|
@@ -65,6 +58,30 @@ Now you can run the toolset via `tfb`:
|
|
- Docker expects Linux-style paths. If you cloned on your `C:\` drive, then `[ABS PATH TO THIS DIR]` would be `/c/FrameworkBenchmarks`.
|
|
- Docker expects Linux-style paths. If you cloned on your `C:\` drive, then `[ABS PATH TO THIS DIR]` would be `/c/FrameworkBenchmarks`.
|
|
- [Docker for Windows](https://www.docker.com/docker-windows) understands `/var/run/docker.sock` even though that is not a valid path on Windows. [Docker Toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/) **may** not - use at your own risk.
|
|
- [Docker for Windows](https://www.docker.com/docker-windows) understands `/var/run/docker.sock` even though that is not a valid path on Windows. [Docker Toolbox](https://docs.docker.com/toolbox/toolbox_install_windows/) **may** not - use at your own risk.
|
|
|
|
|
|
|
|
+## Quick Start Guide (Vagrant)
|
|
|
|
+
|
|
|
|
+Get started developing quickly by utilizing vagrant with TFB. [Git](https://git-scm.com),
|
|
|
|
+[Virtualbox](https://www.virtualbox.org/) and [vagrant](https://www.vagrantup.com/) are
|
|
|
|
+required.
|
|
|
|
+
|
|
|
|
+1. Clone TFB.
|
|
|
|
+
|
|
|
|
+ $ git clone https://github.com/TechEmpower/FrameworkBenchmarks.git
|
|
|
|
+
|
|
|
|
+2. Change directories
|
|
|
|
+
|
|
|
|
+ $ cd FrameworkBenchmarks/deployment/vagrant
|
|
|
|
+
|
|
|
|
+3. Build the vagrant virtual machine
|
|
|
|
+
|
|
|
|
+ $ vagrant up
|
|
|
|
+
|
|
|
|
+4. Run a test
|
|
|
|
+
|
|
|
|
+ $ vagrant ssh
|
|
|
|
+ $ tfb --mode verify --test gemini
|
|
|
|
+
|
|
|
|
+
|
|
## Add a New Test
|
|
## Add a New Test
|
|
|
|
|
|
Once you open an SSH connection to your vagrant box, start the new test initialization wizard.
|
|
Once you open an SSH connection to your vagrant box, start the new test initialization wizard.
|
|
@@ -85,10 +102,10 @@ If you find any errors or areas for improvement within the docs, feel free to ei
|
|
Results of continuous benchmarking runs are available in real time [here](https://tfb-status.techempower.com/).
|
|
Results of continuous benchmarking runs are available in real time [here](https://tfb-status.techempower.com/).
|
|
|
|
|
|
#### Data Visualization
|
|
#### Data Visualization
|
|
-If you have a `results.json` file that you would like to visualize, you can [do that here](https://www.techempower.com/benchmarks/#section=test)(these will be visualized using the metadata from the last known round; if you are adding a new test, it will not visualize anything). You can also attach a `runid` parameter to that url where `runid` is a run listed on [tfb-status](https://tfb-status.techempower.com) like so: https://www.techempower.com/benchmarks/#section=test&runid=fd07b64e-47ce-411e-8b9b-b13368e988c6
|
|
|
|
|
|
+If you have a `results.json` file that you would like to visualize, you can [do that here](https://www.techempower.com/benchmarks/#section=test). You can also attach a `runid` parameter to that url where `runid` is a run listed on [tfb-status](https://tfb-status.techempower.com) like so: https://www.techempower.com/benchmarks/#section=test&runid=fd07b64e-47ce-411e-8b9b-b13368e988c6
|
|
|
|
|
|
## Contributing
|
|
## Contributing
|
|
|
|
|
|
The community has consistently helped in making these tests better, and we welcome any and all changes. Reviewing our contribution practices and guidelines will help to keep us all on the same page. The [contribution guide](https://frameworkbenchmarks.readthedocs.org/en/latest/Development/Contributing-Guide/) can be found in the [TFB documentation](https://frameworkbenchmarks.readthedocs.org/).
|
|
The community has consistently helped in making these tests better, and we welcome any and all changes. Reviewing our contribution practices and guidelines will help to keep us all on the same page. The [contribution guide](https://frameworkbenchmarks.readthedocs.org/en/latest/Development/Contributing-Guide/) can be found in the [TFB documentation](https://frameworkbenchmarks.readthedocs.org/).
|
|
|
|
|
|
-Join in the conversation at our [Google Group](https://groups.google.com/forum/?fromgroups=#!forum/framework-benchmarks), or chat with us on [Freenode](https://webchat.freenode.net/) at `#techempower-fwbm`.
|
|
|
|
|
|
+Join in the conversation on our [mailing list](https://groups.google.com/forum/?fromgroups=#!forum/framework-benchmarks), on [Twitter](https://twitter.com/tfbenchmarks), or chat with us on [Freenode](https://webchat.freenode.net/) at `#techempower-fwbm`.
|