Club-Hub

An app for college students to find on campus clubs

Getting Started

1. Clone this repository on your local machine
2. In the terminal change your directory to client with cd client
3. Call npm i in order to download all necessary packages (this may take a couple minutes the first time)
4. Call ionic serve to host the frontend
5. In a seperate terminal change your directory to server with cd server
6. Call npm i again in this directory
7. Call node server to host the backend
8. If you visit localhost:8100 in your browser, you should see a fully functional version of ClubHub!

Helpful Commands

Here are some helpful commands for testing and linting:

• Use npx eslint filename to lint your file
• Use npm run test to run unit tests
• Use npm run test -- --coverage --watchAll=false to run unit tests with a coverage report
• Use npx run cypress to run acceptance tests (you must be in the client directory)

Static Code Analysis & Test Coverage

The static code analysis and test coverage can be viewed at SonarCloud.com

By most of the SonarCloud's metrics we are doing very well with our static code analysis. The bugs that still remain are left in because SonarCloud doesn’t recognize ionic components. It believes they shouldn’t be referenced in our css files, but this is not actually an issue. We have also reviewed the remaining code smells and have decided that none of them are large enough issues to warrant spending time on fixing. Most of our duplicated code is in our unit testing file, which is fine because some tests have similar structure but should be self-contained. Currently, we are passing SonarCloud's quality gate, so we are happy with the state of our code quality.

Acceptance Tests

Our Acceptance testing specs are viewable here

The implementation of these tests is viewable at client/cypress/integration. Use npx cypress open while in the client directory to run the integration tests.

CI/CD

Continuous Integration/Continuous Deployment is viewable at Travis-ci.com

UML Deployment Diagram

Style Guide

1. Use esm modules
2. Use React framework
3. Use Typescript
4. Use Javascript for config
5. Use spaces for indents
6. Use double quotes for strings
7. Use unix line endings
8. Use semicolons

Code Coverage