61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
# Running It
|
|
|
|
This project was verified with:
|
|
|
|
- Node.js `v24.14.0`
|
|
- npm `11.9.0`
|
|
|
|
Use Node.js v24.14.0, which is the version verified for this project. The application uses Node's built-in `node:sqlite` module for SQLite persistence.
|
|
|
|
## Clean Clone Setup
|
|
|
|
```bash
|
|
git clone https://sdp.ms.wits.ac.za/Mpho10111/coms3011a-lab1
|
|
cd coms3011a-lab1
|
|
npm install
|
|
```
|
|
|
|
## Run the Development Server
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Open the application at:
|
|
|
|
```text
|
|
http://localhost:3000
|
|
```
|
|
|
|
The SQLite database is created automatically on first run at `data/planner.sqlite`. Local SQLite files under `data/` are ignored by Git.
|
|
|
|
## Run Tests
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
`npm test` currently runs 5 deterministic behavioural tests. The tests use a temporary throwaway SQLite database through `TASKS_DB_PATH`; they do not use or modify `data/planner.sqlite`.
|
|
|
|
## Run Linting
|
|
|
|
```bash
|
|
npm run lint
|
|
```
|
|
|
|
## Build the Application
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## Commands from `package.json`
|
|
|
|
| Command | Purpose |
|
|
| --- | --- |
|
|
| `npm run dev` | Starts the Next.js development server. |
|
|
| `npm run build` | Builds the production application. |
|
|
| `npm start` | Starts the production build. |
|
|
| `npm run lint` | Runs ESLint. |
|
|
| `npm test` | Compiles the test target and runs the automated behavioural tests. |
|