Skip to content

Commit

Permalink
Small Next.js app readme updates (#12005)
Browse files Browse the repository at this point in the history
* Small Next.js app readme updates

* Update README.md
  • Loading branch information
amoore108 authored Sep 23, 2024
1 parent 2ebcdb9 commit 5fec64c
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions ws-nextjs-app/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,33 @@
# WS NextJS App
# Next.js App

This is an early POC of a NextJS app to test rendering the new Live pages.
This is the directory that houses the Next.js version of Simorgh.

It utilises existing Simorgh components so as to practice 'evolutionary architecture', we gradually move towards to NextJS app without rebuilding all our React components from scratch. We will gradually migrate across our other page types to this app in the future.
The Next.js app shares components from the Express app (found in the root of the project). It is intended to be used for new page types, and in the future, will be used for the entire site.

For more information on Next.js and how to use the framework, see the [Next.js documentation](https://nextjs.org/docs).

**Note:** We currently use the 'Pages Router' in Next.js, so be sure to select the "Using Pages Router" tab when viewing the Next.js documentation.

---

## Setup

- Run `yarn install` to install dependencies
- Run `yarn dev` to start the development server on `http://localhost:7081`
- Navigate to `http://localhost:7081/kyrgyz/live/cz74kjpyk07t` to see the page

## Running Unit and E2E tests

- Run `yarn test` to run all unit tests
- Run `yarn test:e2e` to run all e2e tests

## Running Integration tests

- Navigate to the root of the project (up one level from here)
- Run `yarn test:integration --nextJS` to run all integration tests for the Next.js app
- Run `yarn test:integration:updatesnaphots --nextJS` to run all integration tests and update any snapshots for the Next.js app

## Running Storybook

- Navigate to the root of the project (up one level from here)
- Run `yarn storybook` to start the Storybook server (it should open automatically in your browser)

0 comments on commit 5fec64c

Please sign in to comment.