generated from RealDevSquad/website-template
-
Notifications
You must be signed in to change notification settings - Fork 9
Open
0 / 10 of 1 issue completedOpen
0 / 10 of 1 issue completed
Copy link
Description
Issue Description
The Feature Flag project (both backend and frontend repositories) has been inactive for some time. Before new development begins, we need to thoroughly investigate the current state of the codebase, validate the setup, and ensure all dependencies, tooling, and scripts are modern, secure, and functional.
This issue focuses on:
- Understanding how the project currently works (build, run, API flow)
- Reviewing all dependencies for outdated or deprecated versions
- Auditing the development environment (Node/Go/SAM, CI, linting, test suites)
- Creating a clear document outlining the findings and next steps
This is mainly a research + documentation task, with safe, non-breaking dependency upgrades included.
Any major upgrades, code changes, or architectural fixes will be tackled in separate issues.
Scope & Objectives
🧩 1. Investigate current project setup
- Understand folder structure and overall architecture of frontend + backend.
- Run the backend locally (Go + AWS SAM + DynamoDB).
- Run the frontend locally (Vite + pnpm).
- Verify tests, linting, and build steps work across both repos.
📦 2. Audit dependencies
- Identify outdated, deprecated, or vulnerable dependencies.
- Document packages that can be safely upgraded (minor/patch).
- Flag major version upgrades that may require code changes.
⚙️ 3. Audit developer tooling and CI
- Review GitHub Actions, scripts, Docker/SAM templates.
- Check Node, Go, pnpm, SAM CLI versions vs latest stable.
- Identify missing or failing CI steps (tests/lint/build).
📄 4. Produce an investigation document
Create a file:
/docs/project-audit.md
This should include:
- Current repo health (build, test, setup)
- Dependency audit results for both repos
- Pain points or inconsistencies
- Recommendations + next steps
- List of suggested follow-up issues
Expected Outcomes
✔️ Dependency health
- Minor/patch-level dependency updates applied where safe.
- Major version upgrades documented with potential risks & impact.
✔️ Clear documentation
A /docs/project-audit.md file summarizing:
- Overall project status
- Known issues or gaps
- Outdated dependencies
- Suggested refactors or upgrades
- CI/tooling modernization suggestions
✔️ Roadmap preparation
Follow-up issues filed for:
- Major dependency updates
- CI improvements
- Backend/Frontend cleanup or refactors
- Documentation improvements
Notes
- This issue is primarily research + documentation focused.
- Only safe (non-breaking) dependency updates will be included here.
- Large/complex refactors or breaking upgrades will be created as separate issues.
Checklist
Project Investigation
- Clone and run both repos locally
- Verify build, lint, and test commands
- Document required Node, pnpm, Go, and SAM versions
Frontend Dependency Audit
- Run
pnpm outdatedand list results - Upgrade safe minor/patch packages
- Document major upgrade requirements
Backend Dependency Audit
- Run
go list -u -m all - Upgrade safe minor/patch modules
- Document major modules requiring attention
CI & Tooling Check
- Audit GitHub Actions and build scripts
- Check for deprecated actions or outdated Node/Go versions
- List CI improvement suggestions
Documentation
- Create
/docs/project-audit.mdsummarizing findings - Propose next steps + create follow-up issues
Sub-issues
Metadata
Metadata
Assignees
Labels
No labels