Releases: Co-App-Team/backend
Sprint 4 release
In this sprint we release:
- Load test
- Bugs fixed and enhanced the robustness of the system
For detail information about each feature. Please see our proposal.
Test plan
Our test plan for sprint 4 can be found here. We update the existing testing plan for sprint 2 and 3 with load test report.
TA Evaluation note
Production environment
We are using Render for hosting both frontend and backend, which are built from Docker images.
Our application is available on: https://coapp-suite.onrender.com/
In the case you need to test backend (through Postman), you can access it at: https://coapp-backend.onrender.com/
Important
Since we are using free service from Render, you may need to wait for 1-10 min for backend to spin up for the first query. After the first query, any follow up query should be at normal speed.
Tip
Since we are using free service from Render, we need to set a third cookie for session management. Please ensure to enable third-party cookie for our application to function properly.
Project package structure
Detailed information about our package structure can be found as follows:
- Backend: https://github.com/Co-App-Team/backend/blob/main/docs/ARCHITECTURE.md
- Frontend: https://github.com/Co-App-Team/frontend/blob/main/docs/ARCHITECTURE.md
Coding style
Information about the coding style that we adopt can be found:
- Backend: https://github.com/Co-App-Team/backend?tab=contributing-ov-file#coding-standard
- Frontend: https://github.com/Co-App-Team/backend?tab=contributing-ov-file#coding-standard
CI pipeline
Our CI pipelines are triggered for every push/commit/PR to main and development branches. You can find CI pipeline for backend and frontend
CD pipeline
Our CD pipeline is set up and can be found here:
- Frontend: https://github.com/Co-App-Team/frontend/blob/develop/.github/workflows/cd-pipeline.yml
- Backend :https://github.com/Co-App-Team/backend/blob/dev/.github/workflows/deploy.yml
On the release day, we trigger CD workflow, which builds and pushes Docker image to DockerHub, via Action:
- Frontend: https://github.com/Co-App-Team/frontend/actions/workflows/cd-pipeline.yml
- Backend: https://github.com/Co-App-Team/backend/actions/workflows/deploy.yml
After the workflows run successfully, the Docker images are built and pushed to:
- Frontend: https://hub.docker.com/repository/docker/ntgbao87/co-app-frontend/general
- Backend: https://hub.docker.com/repository/docker/ntgbao87/co-app-backend/general
Load test
Our load test can be found here. For further description about our load tests, and the report can be found in our Testing plan.
To run load tests (and other tests in the backend), please see the instructions in CONTRIBUTING.md
Security Scanner
We adopt Sonarqube as a security scanner, which will automatically scan every new PR to the default branch (development).
To see the scanning status of our project, please check out SonarQube.
Since we set up Sonarqube at Sprint 3, we have been continuously fixing any new issues raised by Sonarqube in every PR to the default branch.
For your reference, we also spent time fixing code smells found by Sonarqube in the following PRs:
Run our application locally
To build and run our application locally, please follow the instructions:
- For frontend: CONTRIBUTING.md
- For backend: CONTRIBUTING.md
Sprint 3 Release
Sprint 3 Release
In this sprint we release:
- Feature 3: Application Filtering/Search
- Feature 5: Interview Calendar
- Feature 6: AI Resume Helper
For detail information about each feature. Please see our proposal.
Test plan
Our test plan for sprint 3 can be found here. We update the existing testing plan for sprint 2 with additional information:
- Unit tests for feature 3,5,6
- Acceptance tests for feature 3,5,6
- Mutation tests for all features
- Integration tests for feature 3,5,6
Sequence diagram
We provided detailed sequence diagrams for each features here.
TA Evaluation note
Live demo
We are using Render for hosting both frontend and backend.
Our application is available on: https://coapp-suite.onrender.com/
In the case you need to test backend (through Postman), you can access it at: https://coapp-backend.onrender.com/
Important
Since we are using free service from Render, you may need to wait for 1-10 min for backend to spin up for the first query. After the first query, any follow up query should be at normal speed.
Tip
Since we are using free service from Render, we need to set a third cookie for session management. Please ensure to enable third-party cookie for our application to function properly.
Frequent meeting (Scrum)
We meet on weekly basis, our meeting minute for each meeting can be found here.
CD pipeline
Our CD pipeline is set up and can be found here:
- Frontend: https://github.com/Co-App-Team/frontend/blob/develop/.github/workflows/cd-pipeline.yml
- Backend :https://github.com/Co-App-Team/backend/blob/dev/.github/workflows/deploy.yml
On the release day, we trigger CD workflow, which builds and pushes Docker image to DockerHub, via Action:
- Frontend: https://github.com/Co-App-Team/frontend/actions/workflows/cd-pipeline.yml
- Backend: https://github.com/Co-App-Team/backend/actions/workflows/deploy.yml
After the workflows run successfully, the Docker images are built and pushed to:
- Frontend: https://hub.docker.com/repository/docker/ntgbao87/co-app-frontend/general
- Backend: https://hub.docker.com/repository/docker/ntgbao87/co-app-backend/general
Mutation test
Our mutation test can be found here. For further description about our mutation tests and the report can be found in our Testing plan.
CI pipeline
Our CI pipelines are triggered for every push/commit/PR to main and development branches. You can find CI pipeline for backend and frontend
Feature and bug tracking
We track our features and user stories on .github repository.
- Issue for feature 3 can be found here.
- Issue for feature 5 can be found here.
- Issue for feature 6 can be found here.
Bug and dev tasks for each feature is tracked independently on frontend repo and backend repo
Run our application locally
To build and run our application locally, please follow the instructions:
- For frontend: CONTRIBUTING.md
- For backend: CONTRIBUTING.md