Check out the Contribution Guidelines for project structure and code formatting
Setup:
-
Install Python 3.6.3+
- Verify install with the command
python --version
- Verify install with the command
-
Install Node.js (8.11.0+)
-
Only install Node if you want to build web (if you plan on contributing to the project)
-
Verify install with command
node -v
-
Node is currently required as a web build is not included (This will come with a proper release)
-
-
Run setup.bat (or .sh)
Running:
-
Run
webpack.bat
orwebpack.sh
- Only required for building web
-
Run
run_both.bat
orrun_both.sh
-
Test by moving files from
test_directories/test_files
totest_directories/client_dir
ortest_directories/serv_dir