- Node.js v22 or higher is required to run this application.
Install frontend dependencies:
npm installInstall backend dependencies:
npm run install:backendOr install both at once:
npm install && npm run install:backendCreate a .env file in the backend-service folder with your OpenAI API key:
cd backend-service
echo "OPENAI_API_KEY=your_openai_api_key_here" > .envNote: The backend service requires an OpenAI API key to function. We will share before kata starts.
You can run the frontend and backend separately, or together:
Run both frontend and backend together:
npm run dev:allThe kata app will be available at http://localhost:5173.
Note: Ports 5173 and 3000 must be free to run the application.
This project uses TWD (Test While Developing) for frontend testing. The TWD test setup is currently commented out in src/main.tsx but can be enabled for development.
To enable TWD tests, uncomment the test initialization code in src/main.tsx. The tests are located in the src/twd-tests/ directory and will appear in a sidebar when running the development server.
For more information about TWD, visit the official documentation.
For information about Apogee and the kata challenge, visit the landing page when you run the application. The landing page contains all the details about:
- What Apogee is
- What the kata is about
- What tools are available
- Example data structures
npm run dev- Start the frontend development servernpm run backend:dev- Start the backend development servernpm run dev:all- Start both frontend and backend in parallelnpm run build- Build the frontend for productionnpm run lint- Run ESLintnpm run install:backend- Install backend-service dependencies