feat: generate implementation plan and design artifacts
This commit is contained in:
50
specs/001-users-pukpuk-dev/quickstart.md
Normal file
50
specs/001-users-pukpuk-dev/quickstart.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Quickstart Guide
|
||||
|
||||
This guide provides instructions for setting up the project and running the tests.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js (v18 or later)
|
||||
- pnpm
|
||||
|
||||
## Setup
|
||||
|
||||
1. **Clone the repository**:
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd <repository-name>
|
||||
```
|
||||
|
||||
2. **Install dependencies**:
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
3. **Set up environment variables**:
|
||||
Create a `.env` file in the root of the project and add the following variables:
|
||||
```
|
||||
PAYLOAD_CMS_URL=...
|
||||
PAYLOAD_CMS_API_KEY=...
|
||||
```
|
||||
|
||||
## Running the development server
|
||||
|
||||
```bash
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
The application will be available at `http://localhost:4321`.
|
||||
|
||||
## Running the tests
|
||||
|
||||
### Unit tests
|
||||
|
||||
```bash
|
||||
pnpm test:unit
|
||||
```
|
||||
|
||||
### End-to-end tests
|
||||
|
||||
```bash
|
||||
pnpm test:e2e
|
||||
```
|
||||
Reference in New Issue
Block a user