Skip to content

Commit 8f230f8

Browse files
committed
update docs
1 parent 64a5eb3 commit 8f230f8

1 file changed

Lines changed: 62 additions & 3 deletions

File tree

README.md

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,70 @@ yarn dev
3030

3131
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
3232

33-
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
33+
You can start editing the page by modifying files in the `app` directory. The page auto-updates as you edit the file.
3434

35-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
35+
## Testing
3636

37-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
37+
### Running E2E Tests with Cypress
38+
39+
This project uses [Cypress](https://www.cypress.io/) for end-to-end testing.
40+
41+
**Interactive Mode (Recommended for Development)**
42+
43+
```bash
44+
# Make sure the dev server is running
45+
npm run dev
46+
47+
# In another terminal, open Cypress UI
48+
npm run cy:open
49+
```
50+
51+
Then in the Cypress UI:
52+
1. Select "E2E Testing"
53+
2. Choose your browser
54+
3. Click on any test file to run tests
55+
56+
**Headless Mode (CI/CD)**
57+
58+
```bash
59+
# Make sure the dev server is running
60+
npm run dev
61+
62+
# In another terminal, run all tests
63+
npx cypress run
64+
65+
# Run specific test file
66+
npx cypress run --spec "cypress/e2e/Navbar.cy.ts"
67+
```
68+
69+
### Available Test Suites
70+
71+
- `cypress/e2e/Navbar.cy.ts` - Navigation tests (desktop & mobile)
72+
- `cypress/e2e/Footer.cy.ts` - Footer component tests
73+
- `cypress/e2e/Landing.cy.ts` - Landing page tests
74+
- `cypress/e2e/Venue.cy.ts` - Venue page tests
75+
76+
## Storybook
77+
78+
This project uses [Storybook](https://storybook.js.org/) for component development and documentation.
79+
80+
**Running Storybook**
81+
82+
```bash
83+
# Start Storybook development server
84+
npm run storybook
85+
```
86+
87+
This will start Storybook on [http://localhost:6006](http://localhost:6006).
88+
89+
**Building Storybook**
90+
91+
```bash
92+
# Build static Storybook for deployment
93+
npm run build-storybook
94+
```
95+
96+
The static files will be generated in the `storybook-static` directory.
3897

3998
## AsyncAPI Contributors ✨
4099

0 commit comments

Comments
 (0)