Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 2.06 KB

README.md

File metadata and controls

75 lines (47 loc) · 2.06 KB

RealWorld Example App

This project is a reworking of solid-realworld.

The following updates have be made:

  • Builds & runs with Vite
  • Source is now fully typed typescript
  • Rationalised code and added extensive comments
  • Added Follow & Favorite to Article
  • Select an article page directly via URL/slug
  • Article comments now load
  • Replace server API client with one based directly on openAPI
  • Added diagnostic/debug logging
  • Added comprehensive Vitest mock testing
  • Updated workflow to build the project for GitHub Pages

Running the project

The project is hosted on GitHub Pages, visit solid-realworld

To download, build and run the project locally, run the following commands (pnpm is used here but npm and yarn are both ok)

git clone https://github.com/stevej2608/solid-realworld.git

cd solid-realworld

pnpm install

pnpm dev

Visit http://localhost:3000/

Testing

vitest is used for testing the application

pnpm test

VSCODE debugging

In the vscode terminal window run the following command:

pnpm dev

Then press F5 in VSCODE, a Chrome browser window will open.

Set breakpoints and modify the code as required. Hot module replacement (HMR) is enabled.

A debug template for Firefox is included.

LOC

language files code comment blank total
TypeScript JSX 21 1,055 104 175 1,334
TypeScript 13 913 388 267 1,568
CSS 1 16 1 3 20

Links

The canonical realworld project links.