Skip to content

Commit

Permalink
Basic README contents (#12)
Browse files Browse the repository at this point in the history
Starting point for main document introducing the software, explaining requirements and how to get started

* add basic README contents

* Update frontend/README.md

Co-authored-by: Mark Janssen <20283+praseodym@users.noreply.github.com>

* Update frontend/README.md

Co-authored-by: Mark Janssen <20283+praseodym@users.noreply.github.com>

* Update frontend/README.md

Co-authored-by: Mark Janssen <20283+praseodym@users.noreply.github.com>

* change text

* Update frontend/README.md

Co-authored-by: Marjolein Tamis <80948475+marjoleintamis@users.noreply.github.com>

* Update frontend/README.md

Co-authored-by: Marjolein Tamis <80948475+marjoleintamis@users.noreply.github.com>

* Update frontend/README.md

Co-authored-by: Marjolein Tamis <80948475+marjoleintamis@users.noreply.github.com>

* Update frontend/README.md

Co-authored-by: Marjolein Tamis <80948475+marjoleintamis@users.noreply.github.com>

* Update frontend/README.md

Co-authored-by: Marjolein Tamis <80948475+marjoleintamis@users.noreply.github.com>

* Update frontend/README.md

Co-authored-by: Marjolein Tamis <80948475+marjoleintamis@users.noreply.github.com>

---------

Co-authored-by: Mark Janssen <20283+praseodym@users.noreply.github.com>
Co-authored-by: Marjolein Tamis <80948475+marjoleintamis@users.noreply.github.com>
  • Loading branch information
3 people authored Apr 17, 2024
1 parent e80a01f commit 8026f63
Showing 1 changed file with 82 additions and 0 deletions.
82 changes: 82 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,84 @@
# Electoral Council election results management system - Frontend

## Development

### Prerequisites
- [Node](https://nodejs.org) v20


### Building

Install JavaScript dependencies

```sh
npm install
```

Install Playwright dependencies

```sh
npx playwright install --with-deps
```

### Running

This runs the client with a (client-side) mock API

```sh
npm run dev
```

### Linting
```sh
npm run lint
```

### Testing

Unit tests
```sh
npm run test
```

e2e tests
```sh
npm run e2e

# with Playwright web ui
npm run e2eui
```

### UI Component development

Develop and test UI components in isolation.

```sh
npm run ladle
```
Open: http://localhost:61000/

## Structure

### Dependencies

The application uses the following dependencies:

- `react`: creating efficient, declarative, and component-based web applications.
- `react-dom`: DOM implementation for rendering UI
- `react-dom-router`: Handling browser routing for React applications

#### Development dependencies

- `typescript`: Strongly typed layer on top of JavaScript
- `msw`: Mock Service Worker for mocking the server, client side
- `vite`: frontend build tool
- `ladle`: simple development and test environment for UI components

#### Testing / linting dependencies

- `vitest`: Jest compatible unit test framework
- `testing-library`: (React) component and dom test utilities
- `playwright`: e2e testing framework
- `prettier`: Opinionated code formatter
- `eslint`: Linter

0 comments on commit 8026f63

Please sign in to comment.