The development of this project was mainly done using Visual Studio Code (VSCode).
The development of this project was mainly done using Visual Studio Code (VSCode).
It is not that surprising, then, that we recommend you use it.
## Extensions
...
...
@@ -18,9 +18,9 @@ But there was a few issues with the Python extension that made Live Share hard t
## Tasks
A task in VSCode is a simple action that can be run by pressing `ctrl+shift+p`, searching for and selecting `Tasks: Run Task`.
These tasks a configured in the `.vscode/tasks.json` file.
Tasks that are build tasks can also be run with `ctrl+shift+b`.
A task in VSCode is a simple action that can be run by pressing `ctrl+shift+p`, searching for and selecting `Tasks: Run Task`.
These tasks are configured in the `.vscode/tasks.json` file.
Tasks that are marked as build tasks (starting and testing tasks as well as populate) can also be run with `ctrl+shift+b`.
A few such tasks has been setup in this project and will be described below.
The `Start server` task will start the server.
...
...
@@ -31,14 +31,16 @@ The `Start client and server` task will start both the client and the server.
The `Populate database` task will populate the database with a few competitions, teams, users and such. Look in the `populate.py` to see exactly what it adds. Remember to always run this after changing the structure of the database.
The `Test server` task will run the server tests located in the `tests/` folder.
The `Test server` task will run the server tests located in the `server/tests/` folder.
The `Open server coverage` can only be run after running the server tests and will open the coverage report generated by those tests in a webbrowser.
The `Open server coverage`task can only be run after running the server tests and will open the coverage report generated by those tests in a webbrowser.
The `Test client` task will run `npm test`.
The `Unit tests` task will run the unit tests for the client.
The `Open client coverage` can only be run after running the client tests and will open the coverage report generated by those tests in a webbrowser.
The `Run e2e tests` task will run the end-to-end tests.
The `Generate documentation` will generate the project documentation, i.e. this document, in the `docs/build/html/` folder.
The `Open client coverage` task can only be run after running the client tests (`Unit tests` task) and will open the coverage report generated by those tests in a webbrowser.
The `Open documentation` can only be run after generating the documentation and will open it in a webbrowser.
The `Generate documentation` task will generate the project documentation, i.e. this document, in the `docs/build/html/` folder.
The `Open documentation` task can only be run after generating the documentation and will open it in a webbrowser.
