BitGoblin/colossus
1
0
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases Wiki Activity

Updated README with development instructions

Browse Source
This commit is contained in:
Gregory Ballantine 2023-09-20 20:09:28 -06:00
parent 408b3baf8f
commit e176398f41
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,3 +1,26 @@
# colossus
Self-hosted database for organizing PC hardware benchmarking results
Self-hosted database for organizing PC hardware benchmarking results.
## Project Goals
The goals of this project are to:
* Record benchmarking results from multiple devices - e.g. log from a laptop or a phone.
* Group results into tests - it's good practice to run a benchmark multiple times for accuracy.
* Create comparisons of hardware tests to compare performance.
* Generate graphs of hardware comparisons for usage in videos and articles.
## Development
The recommended way to run the development server for Colossus is using [Docker](https://docker.com/).
There are some shell and batch scripts in `bin/` to build and run the containers. To build the containers:
`bin/docker-build.sh` or `bin/docker-build.bat`
And then to run the containers:
`bin/docker-run.sh` or `bin/docker-run.bat`
This will build the containers for Apache and Grunt to serve the web pages and build front-end assets, respectively. If everything is running successfully you can open your browser and go to https://localhost:8080.