lfk
/
backend
2
0
Fork 0
Code Issues 1 Pull Requests Projects Releases 40 Wiki Activity

fix: updated README for pnpm, typos

This commit is contained in:
Philipp Dormann 2023-11-06 18:04:32 +01:00
parent 50dd703a1b
commit 5082b1b8b1
Signed by: philipp
GPG Key ID: 3BB9ADD52DCA4314
2 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -15,24 +15,24 @@ Backend Server
1. Rename the .env.example file to .env (you can adjust app port and other settings, if needed) 1. Rename the .env.example file to .env (you can adjust app port and other settings, if needed)
2. Install Dependencies 2. Install Dependencies
```bash ```bash
yarn pnpm i
``` ```
3. Start the server 3. Start the server
```bash ```bash
yarn dev pnpm dev
``` ```
### Run Tests ### Run Tests
```bash ```bash
# Run tests once (server has to run) # Run tests once (server has to run)
yarn test pnpm test
# Run test in watch mode (reruns on change) # Run test in watch mode (reruns on change)
yarn test:watch pnpm test:watch
# Run test in ci mode (automaticly starts the dev server) # Run test in ci mode (automaticly starts the dev server)
yarn test:ci pnpm test:ci
``` ```
### Use your own mail templates ### Use your own mail templates
@ -44,7 +44,7 @@ Currently the following templates exist:
### Generate Docs ### Generate Docs
```bash ```bash
yarn docs pnpm docs
``` ```
## ENV Vars ## ENV Vars
@ -90,5 +90,5 @@ yarn docs
* The dev tag of the docker image get's build from this * The dev tag of the docker image get's build from this
* Only push minor changes to this branch! * Only push minor changes to this branch!
* To merge a feature branch into this please create a pull request * To merge a feature branch into this please create a pull request
* feature/xyz: Feature branches - nameing scheme: `feature/issueid-title` * feature/xyz: Feature branches - naming scheme: `feature/issueid-title`
* bugfix/xyz: Branches for bugfixes - nameing scheme:`bugfix/issueid-title` * bugfix/xyz: Branches for bugfixes - naming scheme:`bugfix/issueid-title`

2
src/seeds/SeedUsers.ts
View File

@ -11,7 +11,7 @@ import { PermissionAction } from '../models/enums/PermissionAction';
import { PermissionTarget } from '../models/enums/PermissionTargets'; import { PermissionTarget } from '../models/enums/PermissionTargets';
/** /**
* Seeds a admin group with a demo user into the database for initial setup and auto recovery. * Seeds a admin group with a demo user into the database for initial setup and auto recovery.
* We know that the nameing isn't perfectly fitting. Feel free to change it. * We know that the naming isn't perfectly fitting. Feel free to change it.
*/ */
export default class SeedUsers implements Seeder { export default class SeedUsers implements Seeder {
public async run(factory: Factory, connection: Connection): Promise<any> { public async run(factory: Factory, connection: Connection): Promise<any> {