From a88bf8ebdbacd1c29e8c50e11c9a95c7dcc8342b Mon Sep 17 00:00:00 2001 From: Andreas Kluge Svendsrud <89779148+kludge7@users.noreply.github.com> Date: Sat, 6 Apr 2024 14:11:31 +0200 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 4459057..4e3ab17 100644 --- a/README.md +++ b/README.md @@ -56,5 +56,30 @@ npm run test:e2e # Common Issues and Troubleshooting +## Issues with the Backend Server + +1. **Is your Backend running?**: ~~Well you better go catch it~~ First, verify that the backend server process is active. + +2. **Verify Server Status**: After starting the backend server, ensure it is running on localhost and listening on port 8080. + # CI/CD - Github Actions +## Communication Fault +**Issue**: The application fails to connect to the database, indicating a possible misconfiguration. +**Solution**: Ensure your database is correctly configured. Common misconfigurations include incorrect database URL, port, username, or password. Double-check your configurations. + +# CI/CD - Github Actions +## CI +Tests are run continuously with the Continuous Integration pipeline through Github Actions. The pipeline executes npm commands to build the application and run tests. + +## CD +The Continuous Deployment pipeline automates the deployment of the Quizopia frontend application to GitHub Packages whenever changes are pushed to the main branch. NOTE: It only gets deployed if the version number is incremented in package.json: +```json +{ + "name": "@heikkkk/idatt2105-semester-project-frontend", + "version": "X.X.X", + "repository": { + "type": "git", + "url": "git://github.com/heikkkk/IDATT2105-Semester-Project-Frontend.git" + }, +```