Skip to content

Commit dd4fe05

Browse files
update README
1 parent 54f367f commit dd4fe05

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

frontend/README.md

+38-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
1-
# Lissi App
1+
# Frontend
22

3-
TODO
3+
This is the frontend for the event planner app.
4+
5+
## Prerequisites
6+
7+
To run the frontend locally you need `node` version 22 and npm installed.
8+
In addition, the frontend needs the backend to run on port 8081 for local development.
9+
10+
## Getting started
11+
12+
### Install dependencies
13+
```bash
14+
npm install
15+
```
16+
17+
### Starting the dev server
18+
This starts the frontend on http://localhost:8080.
19+
```bash
20+
npm run dev
21+
```
22+
23+
### Building
24+
These steps are also executed in the pipeline and will break the build, when an error is found.
25+
It is recommended to run these scripts at least once before commiting.
26+
```bash
27+
npm run lint
28+
npm run format
29+
npm run build
30+
```
31+
32+
## Dependencies
33+
- [Node 22](https://nodejs.org/en/)
34+
- [Vite](https://vitejs.dev/)
35+
- [Vue 3](https://v3.vuejs.org/)
36+
- [Tailwind CSS](https://tailwindcss.com/)
37+
- [ESLint](https://eslint.org/)
38+
- [Prettier](https://prettier.io/)
39+
- [Vue I18n](https://vue-i18n.intlify.dev/)

0 commit comments

Comments
 (0)