CSCI 3601 Iteration Template

Development
- Common commands
Deployment
Resources
Changing the name
Contributors

This is your starter code for Iteration 1.

There is quite a lot of example code in this production template that you don't want or need down the road, but is included to help you get started. As you work on your project, you should replace these pieces with elements of your project and remove whatever you don't need (e.g., markdown files, JSON data files, or any remnants of the labs). We include, for example, the User parts of the previous labs. These are almost certainly not relevant to your project and should be removed once you've started.

:bangbang: Keeping things like the support for our User types will artificially inflate your test coverage results, making it look like you have much better coverage than you actually do. This is neither cool nor helpful, so you really should remove our code fairly early in your iteration.

:exclamation: You should remove this sentence and the text above, and replace them with at least an elevator pitch description of your project so that if someone comes to this repo they'll know what the project is about.

Development

Instructions on setting up the development environment and working with the code are in the development guide.

Common commands

From the server directory:

./gradlew run to start the server
./gradlew test to test the server
./gradlew checkstyleMain to run Checkstyle on the server Java code in the src/main folder
./gradlew checkstyleTest to run Checkstyle on the server Java code in the src/test folder
./gradlew check will run the tests, run the Checkstyle checks, and generate coverage reports in one command

From the client directory:

ng serve to run the client
ng test to test the client
- Or ng test --no-watch --code-coverage to run the client tests once and also compute the code coverage.
ng e2e and ng e2e --watch to run end-to-end tests

From the database directory:

./mongoseed.sh (or .\mongoseed.bat on Windows) to seed the database

Deployment

Instructions on how to create a DigitalOcean Droplet and setup your project are in the deployment guide.

Resources

Additional resources on tooling and techniques are in the resources list.

Changing the name

The project by default has the name "CSCI 3601 Iteration Template". There are a few places you need to change to make this the name you want:

The title in this README.md
client/src/app/app.component.ts
- The title variable
- Also the associated unit and E2E tests will need to be changed.
client/src/app/app.component.html
- The mat-toolbar element for the navigation drawer is just "Client" by default.
client/src/index.html
- The title element