1.9 KiB
1.9 KiB
01. Initialize SolidJS OpenTUI Project with Bun
meta: id: podcast-tui-app-01 feature: podcast-tui-app priority: P0 depends_on: [] tags: [project-setup, solidjs, opentui, bun]
objective:
- Initialize a new SolidJS-based OpenTUI project using Bun
- Set up project structure with all necessary dependencies
- Configure TypeScript and development environment
deliverables:
/podcast-tui-app/directory createdpackage.jsonwith all dependenciestsconfig.jsonconfigured for TypeScriptbunfig.tomlwith Bun configuration.gitignorefor Git version controlREADME.mdwith project description
steps:
- Run
bunx create-tui@latest -t solid podcast-tui-appto initialize the project - Verify project structure is created correctly
- Install additional dependencies:
bun add @opentui/solid @opentui/core solid-js zustand - Install dev dependencies:
bun add -d @opentui/testing @opentui/react @opentui/solid - Configure TypeScript in
tsconfig.jsonwith SolidJS and OpenTUI settings - Create
.gitignorewith Node and Bun specific files - Initialize Git repository:
git init
tests:
- Unit: Verify
create-tuicommand works without errors - Integration: Test that application can be started with
bun run src/index.tsx - Environment: Confirm all dependencies are installed correctly
acceptance_criteria:
- Project directory
podcast-tui-app/exists package.jsoncontains@opentui/solidand@opentui/coredependenciesbun run src/index.tsxstarts the application without errors- TypeScript compilation works with
bun run build
validation:
- Run
bun run buildto verify TypeScript compilation - Run
bun run src/index.tsxto start the application - Run
bun pm lsto verify all dependencies are installed
notes:
- OpenTUI is already installed in the system
- Use
-t solidflag for SolidJS template - All commands should be run from the project root