Archived all completed OpenSpec changes, created .gitignore, implemented Gitea CI/CD, updated frontend with professional styling and clickable IPs, and added application documentation.
This commit is contained in:
@@ -0,0 +1,36 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Project README File
|
||||
The project SHALL include a `README.md` file in the project root.
|
||||
|
||||
#### Scenario: README file existence
|
||||
- **WHEN** the project repository is initialized or cloned
|
||||
- **THEN** a `README.md` file SHALL be present in the root directory.
|
||||
|
||||
### Requirement: Application Overview
|
||||
The `README.md` file SHALL provide a brief overview of the application's purpose and functionality.
|
||||
|
||||
#### Scenario: User reads README
|
||||
- **WHEN** a user reads the `README.md` file
|
||||
- **THEN** they SHALL understand the application's purpose.
|
||||
|
||||
### Requirement: Prerequisites for Running
|
||||
The `README.md` file SHALL list all necessary prerequisites for running the application.
|
||||
|
||||
#### Scenario: User prepares to run application
|
||||
- **WHEN** a user consults the `README.md` for setup
|
||||
- **THEN** they SHALL find a list of required software (e.g., Docker, Node.js/npm).
|
||||
|
||||
### Requirement: Local Run Instructions
|
||||
The `README.md` file SHALL provide step-by-step instructions for running the application locally using Docker Compose.
|
||||
|
||||
#### Scenario: User runs application locally
|
||||
- **WHEN** a user follows the `README.md` instructions for local setup
|
||||
- **THEN** they SHALL be able to successfully start the application using Docker Compose.
|
||||
|
||||
### Requirement: Service Access Instructions
|
||||
The `README.md` file SHALL provide instructions on how to access the frontend and backend services once they are running.
|
||||
|
||||
#### Scenario: User accesses running services
|
||||
- **WHEN** a user has started the application
|
||||
- **THEN** they SHALL find information on the URLs/ports to access the frontend and backend.
|
||||
@@ -0,0 +1,40 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Gitea Actions Workflow File
|
||||
The project SHALL include a Gitea Actions compatible workflow file for CI/CD.
|
||||
|
||||
#### Scenario: Workflow file existence
|
||||
- **WHEN** the project repository is initialized or cloned
|
||||
- **THEN** a workflow file SHALL be present in the `.gitea/workflows/` or `.github/workflows/` directory.
|
||||
|
||||
### Requirement: Docker Image Build Automation
|
||||
The CI/CD pipeline SHALL automatically build Docker images for the backend and frontend services.
|
||||
|
||||
#### Scenario: Code push to main branch
|
||||
- **WHEN** code is pushed to the `main` branch
|
||||
- **THEN** the backend Docker image SHALL be built.
|
||||
- **AND** the frontend Docker image SHALL be built.
|
||||
|
||||
### Requirement: Docker Image Tagging
|
||||
The built Docker images SHALL be tagged with `latest` and the short commit SHA.
|
||||
|
||||
#### Scenario: Image build completion
|
||||
- **WHEN** a Docker image is successfully built
|
||||
- **THEN** the image SHALL be tagged with `latest`.
|
||||
- **AND** the image SHALL be tagged with the short commit SHA.
|
||||
|
||||
### Requirement: Docker Image Push to Gitea Registry
|
||||
The built Docker images SHALL be pushed to the internal Gitea package registry.
|
||||
|
||||
#### Scenario: Image build and tagging completion
|
||||
- **WHEN** Docker images are successfully built and tagged
|
||||
- **THEN** the backend image SHALL be pushed to the Gitea package registry.
|
||||
- **AND** the frontend image SHALL be pushed to the Gitea package registry.
|
||||
|
||||
### Requirement: Self-Hosted Runner Usage
|
||||
The CI/CD workflow SHALL utilize a self-hosted runner with the label "run".
|
||||
|
||||
#### Scenario: Workflow execution
|
||||
- **WHEN** the CI/CD workflow is executed
|
||||
- **THEN** it SHALL run on a self-hosted runner.
|
||||
- **AND** the self-hosted runner SHALL have the label "run".
|
||||
Reference in New Issue
Block a user