Issue Tracker Project

For our term project in CPSC 300: Software Engineering, we decided to build a standalone web application with functionality similar to that of the on-board issue tracker in GitHub.

Team Members

• Jonathan Shaw
• Kai Lan
• Kelvan Johnson
• Sofia Jones

Our primary remote repository is hosted on-site at University of Northern British Columbia---as such, only major changes to the master branch will be pushed to the publically-available GitHub repository.

Testing the Project

The project is deployed live at the following link.

https://cpsc300-issue-tracker.herokuapp.com/#/

One can also test the project by setting it up one's self (see next section)

Running, Developing, Building, and Deploying the Project

Setting Up Development Environment

You will need:

• A recent version of Node.js. The author of this document uses 15.2.1, but the most recent LTS release should work.
• An instance of MongoDB running locally on port 27017
• A modern browser. The project has been tested in the latest versions of Firefox and Chrome.

Any modern operating system should support the project. It has been tested on up-to-date copies of Arch Linux and Windows 10.

Installing Dependencies

Initially, you will need to run npm install in two different directories:

• The project root directory
• The client directory

Running the project (development)

• To run only the backend, use the script npm run devBackend from the root directory.
• To run only the frontend, use the script npm run devFrontend from the root directory. Alternatively, use npm run serve in the client directory.
• To run both concurrently, use npm run dev from the project root directory. This is the best way to run the project locally for testing and development.

The necessary environment variables are pre-set under ./config/dev.env.

In development, the backend runs on Port 3000 while the frontend runs on Port 8080. To view the frontend in your browser, visit localhost:8080.

Running backend test suites

To run the integrated backend unit test suite, use the script npm run test from the project root directory.

Deploying

• To create a production-ready build, set the environment variable NODE_ENV=production and also run the npm run build script on the client directory. The REST API and frontend will be served on the same port (which is 3000 by default, but can be set using the PORT environment variable).