You will need the latest versions of nodejs
and npm
for your platform.
Use npm install
to install package dependencies, then run the server with npm run start-server
,
and in a separate shell run the client with npm run start-client
. You may now connect to
localhost:3000
to use ChessHub.
Please see the Release Notes PDF document in the repository.
We are using Git for version control (hence the repository).
We are using eslint for static analysis. Please see the staticanalysis.txt
document
for details regarding eslint, and static analysis results.
We are using jest for code testing and coverage, along with Travis CI and Coveralls
to automate builds and generate coverage reports per commit. Please see
the coverage.txt
and coverage.png
files for details and coverage results.
We are using GitHub Issues to manage bug tracking. See the Issues tab at the top.
We are using GitHub Releases to manage change requests and candidate releases. Please see the Releases tab on the right.
All code used for the backend server may be found in backend/
and code for frontend
client may be found in src/
. Most frontend code is located in src/components/
as
React.js components. The chess library (used for move validation) is located in
src/components/chess/
.