Skip to content

Commit 79074b8

Browse files
chore: remove outdated development quick start instructions from README
1 parent a612f50 commit 79074b8

1 file changed

Lines changed: 0 additions & 73 deletions

File tree

README.md

Lines changed: 0 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -500,79 +500,6 @@ To clean up the build, coverage and test reports run:
500500
```
501501
pnpm clean
502502
```
503-
## Development Quick Start (Docker Compose)
504-
505-
Install Docker Desktop following the [official guide](https://docs.docker.com/desktop/).
506-
You may have to uninstall Docker on your machine if you installed it using a different guide.
507-
508-
Clone repository and enter directory:
509-
```
510-
git clone git@github.com:Cameri/nostream.git
511-
cd nostream
512-
```
513-
514-
Start:
515-
```
516-
nostream start
517-
```
518-
519-
This will run in the foreground of the terminal until you stop it with Ctrl+C.
520-
521-
## Tests
522-
523-
### Linting and formatting (Biome)
524-
525-
Run code quality checks with Biome:
526-
527-
```
528-
pnpm lint
529-
pnpm lint:fix
530-
pnpm format
531-
pnpm check:format
532-
```
533-
534-
### Unit tests
535-
536-
Open a terminal and change to the project's directory:
537-
```
538-
cd /path/to/nostream
539-
```
540-
541-
Run unit tests with:
542-
543-
```
544-
pnpm test:unit
545-
```
546-
547-
Or, run unit tests in watch mode:
548-
549-
```
550-
pnpm test:unit:watch
551-
```
552-
553-
To get unit test coverage run:
554-
555-
```
556-
pnpm cover:unit
557-
```
558-
559-
To see the unit tests report open `.test-reports/unit/index.html` with a browser:
560-
```
561-
open .test-reports/unit/index.html
562-
```
563-
564-
To see the unit tests coverage report open `.coverage/unit/lcov-report/index.html` with a browser:
565-
```
566-
open .coverage/unit/lcov-report/index.html
567-
```
568-
569-
### Integration tests (Docker Compose)
570-
571-
Open a terminal and change to the project's directory:
572-
```
573-
cd /path/to/nostream
574-
```
575-
576503
## Development & Contributing
577504
578505
For development environment setup, testing, linting, load testing, and contribution guidelines

0 commit comments

Comments
 (0)