37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
## 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.
|