Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,10 +183,15 @@ yarn install
To run this application locally, with hot-reloading, run

```
yarn dev
yarn dev:all
```

The application will start on [http://localhost:7080](http://localhost:7080).
The express application will start on [http://localhost:7080](http://localhost:7080).
The nextJS application will start on [http://localhost:7081](http://localhost:7081).
Comment thread
Isabella-Mitchell marked this conversation as resolved.

Once the application is running, you can visit a valid route, e.g. http://localhost:7081/pidgin.

### Article pages

Article pages are served at routes of the format `/news/articles/:id` where id is the asset ID generated by the Content Management System.

Expand All @@ -211,17 +216,16 @@ Services with variants can't be accessed using the format above, instead the var

World Service home pages are served in the format `/:service` where `service` represents a World Service site:

- [http://localhost:7080/igbo](http://localhost:7080/igbo)
- [http://localhost:7080/pidgin](http://localhost:7080/pidgin)
- [http://localhost:7081/igbo](http://localhost:7081/igbo)
- [http://localhost:7081/pidgin](http://localhost:7081/pidgin)

Services with variants can't be accessed using the format above, instead the variant must be provided in the URL.

- [http://localhost:7080/zhongwen/simp](http://localhost:7080/zhongwen/simp)
- [http://localhost:7080/zhongwen/simp.amp](http://localhost:7080/zhongwen/simp.amp).
- [http://localhost:7081/zhongwen/simp](http://localhost:7081/zhongwen/simp)
- [http://localhost:7081/zhongwen/simp.amp](http://localhost:7081/zhongwen/simp.amp).

World Service home pages do not support AMP.


### Topic Pages

Topic pages use internal BBC APIs that are not publicly accessible. This can cause the following warnings to appear when developing locally:
Expand All @@ -236,6 +240,8 @@ Internal developers who need to work on topic pages locally should contact the t

You can find other pages types by looking through our routes and their associates regexes, but we suggest you start with the above then have a look at the core of the application to understand and find the other routes.

[See a list of local route examples here](https://github.com/bbc/simorgh/blob/latest/docs/Simorgh-Release-Info.mdx).

### Storybook (UI Development Environment/Style Guide)

We use Storybook for developing components in isolation from the Simorgh Application. You can access this at [https://bbc.github.io/simorgh/](https://bbc.github.io/simorgh/)
Expand Down
Loading
Loading