Skip to content

Commit

Permalink
README updated (#61)
Browse files Browse the repository at this point in the history
* README updated
  • Loading branch information
thomasm0 authored Sep 5, 2024
1 parent 4144ee8 commit d594999
Showing 1 changed file with 4 additions and 20 deletions.
24 changes: 4 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,14 @@
# Engineering Enablement React Template
# React Map Demos

Team responsible: Engineering Enablement team

This starter kit is built on top of Vite 5.x for writing React based applications in TypeScript.
Team responsible: Engineering Enablement

## Aims of this repo

This repository aims to provide developers with a simple and unopinionated codebase to develop frontend-based React applications with. Simple meaning minimal config and maintenance overheads.

## Features

- ESLint - scripts linter
- Stylelint - styles linter
- Prettier - formatter
- Vitest - test framework
- Husky + lint-staged - pre-commit git hook set up for formatting
This project uses [Storybook](https://storybook.js.org/) to provide demos and examples of common use-cases of maps for Gemeente Amsterdam. The preferred map library is [Leaflet](https://leafletjs.com/) implemented in the frontend library [React](https://react.dev/).

## How to use this repo?

You can create a repository based on this [repository template](https://github.com/amsterdam/ee-react-template/generate) or simply clone the repository:

```bash
git clone https://github.com/amsterdam/ee-react-template.git
cd ee-react-template
npm i
```
This project is generated from a [repository template](https://github.com/amsterdam/ee-react-template).

### Usage

Expand Down

0 comments on commit d594999

Please sign in to comment.