Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #106

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# lildog-kundestyrt

## How to run frontend
Make sure to change into the ` client ` directory before executing commands.
1. Installing the dependencies
```bash
npm i
```

### Running as a development server
2. Run the project as a development server
```bash
npm run dev
```

### Deploying the client side
2. Build the project
```bash
npm run build
```
3. Deploy the `dist` folder to a web server or container.

## How to run backend
### 1. Create and enter a venv
This is recommended to avoid issues with differing versions of packages in project and local environment. In addition, this avoids bloat not necessary for the project being added when freezing requirements.
Expand Down