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,2 @@
|
||||
schema: spec-driven
|
||||
created: 2026-03-27
|
||||
@@ -0,0 +1,35 @@
|
||||
## Context
|
||||
|
||||
The project currently lacks a `.gitignore` file, which results in various development-related files, build artifacts, and dependency directories being untracked or potentially committed to version control. This leads to a cluttered repository and can cause issues with consistency across different development environments.
|
||||
|
||||
## Goals / Non-Goals
|
||||
|
||||
**Goals:**
|
||||
- Create a comprehensive `.gitignore` file at the project root.
|
||||
- Ensure that common development artifacts, temporary files, dependency directories, and OS/IDE-specific files are ignored by Git.
|
||||
- Maintain a clean and focused Git repository.
|
||||
|
||||
**Non-Goals:**
|
||||
- This design does not aim to modify existing Git history or remove already committed files.
|
||||
- It does not cover advanced Git configurations beyond the `.gitignore` file itself.
|
||||
- It will not address ignoring files that are intentionally part of the repository (e.g., configuration files that need to be tracked).
|
||||
|
||||
## Decisions
|
||||
|
||||
1. **Location**: The `.gitignore` file will be placed in the root directory of the project (`/home/filip/docker-backend-display/.gitignore`).
|
||||
2. **Content - General**: It will include standard ignore patterns for:
|
||||
- Node.js specific files and directories (`node_modules`, `npm-debug.log`, `build`, `dist`, etc.).
|
||||
- Operating System specific files (`.DS_Store`, `Thumbs.db`).
|
||||
- Common IDE/Editor specific files (`.vscode/`, `.idea/`, `*.swp`).
|
||||
3. **Content - Project Specific**: It will include patterns for:
|
||||
- Backend build artifacts (if any are generated outside `node_modules`).
|
||||
- Frontend build artifacts (`frontend/build`).
|
||||
- Log files (`*.log`).
|
||||
- Environment variables (`.env`).
|
||||
|
||||
## Risks / Trade-offs
|
||||
|
||||
- **[Risk]** Over-ignoring essential files: There is a risk that some files necessary for the project's build or execution might be inadvertently ignored.
|
||||
- **Mitigation**: The `.gitignore` file will be carefully reviewed after creation, and tested by checking `git status` to ensure only intended files are ignored.
|
||||
- **[Risk]** Under-ignoring sensitive or large files: Some sensitive information or large binary files might be missed, leading to them being committed.
|
||||
- **Mitigation**: The `.gitignore` will be based on widely accepted templates for Node.js/React projects, and specific project directories will be explicitly added.
|
||||
@@ -0,0 +1,21 @@
|
||||
## Why
|
||||
|
||||
To prevent unnecessary files (such as build artifacts, dependency directories, and temporary files) from being committed to version control. This keeps the repository clean, reduces repository size, and ensures that only relevant source code is tracked.
|
||||
|
||||
## What Changes
|
||||
|
||||
- A new `.gitignore` file will be created in the project root. This file will contain patterns for files and directories that should be ignored by Git.
|
||||
|
||||
## Capabilities
|
||||
|
||||
### New Capabilities
|
||||
- `git-ignore-management`: Manages the set of files and directories that Git should ignore across the project.
|
||||
|
||||
### Modified Capabilities
|
||||
- None
|
||||
|
||||
## Impact
|
||||
|
||||
- The project's Git repository will be cleaner and more focused on source code.
|
||||
- Development workflow will be improved by preventing accidental commits of irrelevant files.
|
||||
- Reduced repository size and faster cloning/fetching operations.
|
||||
@@ -0,0 +1,39 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Project Root .gitignore File
|
||||
The project SHALL include a `.gitignore` file at its root directory.
|
||||
|
||||
#### Scenario: .gitignore file existence
|
||||
- **WHEN** the project repository is initialized or cloned
|
||||
- **THEN** a `.gitignore` file SHALL be present in the root directory.
|
||||
|
||||
### Requirement: Ignore Node.js Dependencies
|
||||
The `.gitignore` file SHALL include patterns to ignore Node.js dependency directories and related build artifacts.
|
||||
|
||||
#### Scenario: Node.js project files
|
||||
- **WHEN** a Node.js project is being developed
|
||||
- **THEN** `node_modules/` SHALL be ignored.
|
||||
- **AND** `npm-debug.log` SHALL be ignored.
|
||||
- **AND** `build/` directories within Node.js projects SHALL be ignored.
|
||||
- **AND** `dist/` directories within Node.js projects SHALL be ignored.
|
||||
|
||||
### Requirement: Ignore OS and IDE Specific Files
|
||||
The `.gitignore` file SHALL include patterns to ignore operating system and integrated development environment (IDE) specific files.
|
||||
|
||||
#### Scenario: OS and IDE generated files
|
||||
- **WHEN** development is performed on various operating systems or IDEs
|
||||
- **THEN** `.DS_Store` SHALL be ignored.
|
||||
- **AND** `Thumbs.db` SHALL be ignored.
|
||||
- **AND** `.vscode/` directory SHALL be ignored.
|
||||
- **AND** `.idea/` directory SHALL be ignored.
|
||||
- **AND** `*.swp` files SHALL be ignored.
|
||||
|
||||
### Requirement: Ignore Project-Specific Build Artifacts and Logs
|
||||
The `.gitignore` file SHALL include patterns to ignore project-specific build output directories and log files.
|
||||
|
||||
#### Scenario: Project build and log files
|
||||
- **WHEN** the frontend or backend services are built
|
||||
- **THEN** `frontend/build/` SHALL be ignored.
|
||||
- **AND** `backend/build/` SHALL be ignored.
|
||||
- **AND** `*.log` files SHALL be ignored.
|
||||
- **AND** `.env` files SHALL be ignored.
|
||||
@@ -0,0 +1,19 @@
|
||||
## 1. Create .gitignore File
|
||||
|
||||
- [x] 1.1 Create a `.gitignore` file in the project root (`/home/filip/docker-backend-display/.gitignore`).
|
||||
- [x] 1.2 Add patterns to ignore Node.js dependency directories and related build artifacts:
|
||||
- `node_modules/`
|
||||
- `npm-debug.log`
|
||||
- `build/`
|
||||
- `dist/`
|
||||
- [x] 1.3 Add patterns to ignore OS and IDE specific files:
|
||||
- `.DS_Store`
|
||||
- `Thumbs.db`
|
||||
- `.vscode/`
|
||||
- `.idea/`
|
||||
- `*.swp`
|
||||
- [x] 1.4 Add patterns to ignore project-specific build artifacts and logs:
|
||||
- `frontend/build/`
|
||||
- `backend/build/`
|
||||
- `*.log`
|
||||
- `.env`
|
||||
Reference in New Issue
Block a user