Skip to content

Commit

Permalink
Ignore vs code config files (#606)
Browse files Browse the repository at this point in the history
* Rename VS Code configs to `.example`

* Add new "Start all but database" task

* Explain changes in readme
  • Loading branch information
lukasrad02 authored Jan 18, 2023
1 parent 5822225 commit 227f0dc
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,7 @@ shared/tsconfig.build.tsbuildinfo

benchmark/data/*
!benchmark/data/*.permanent.json

.vscode/*
!.vscode/*.example
!.vscode/extensions.json
File renamed without changes.
File renamed without changes.
6 changes: 6 additions & 0 deletions .vscode/tasks.json → .vscode/tasks.json.example
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
"isBackground": true,
"problemMatcher": []
},
{
"label": "Start all but database",
"dependsOn": ["Start frontend", "Start backend", "Watch shared"],
"isBackground": true,
"problemMatcher": []
},
{
"label": "Run CI",
"dependsOn": [
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ This project is currently developed as a [bachelor project](https://hpi.de/en/st
You can (optionally) use a database for the persistence of exercise data. Look at the [relevant section](./backend/README.md#database) in the backend README for further information.
Note that to not use the database you have to edit an environment variable, see the [relevant section](./backend/README.md#without-a-database).
8. (Optional) We have a list of recommended [vscode](https://code.visualstudio.com/) extensions. We strongly recommend you to use them if you are developing. You can see them via [the `@recommended` filter in the extensions panel](https://code.visualstudio.com/docs/editor/extension-marketplace#_recommended-extensions).
9. (Optional) We have prepared default settings, tasks and debug configurations for VS Code. You can find them in `.vscode/*.example`. Crete a copy of those files removing the `.example` and adjust them to your needs. The files without `.example`-Extensions are untracked so your adjustments won't be committed automatically.

### Gotchas

Expand All @@ -49,6 +50,7 @@ If you want the best developer experience, make sure to always install dependenc

If you are using [vscode](https://code.visualstudio.com/), you can run the [task](https://code.visualstudio.com/docs/editor/tasks) `Start all` to start everything in one go.
Note that this _tries_ to start the database using `docker compose`. In case this fails please start the database in another way (see [this section in the backend README](./backend/README.md#database)).
If you're not using a database anyway, you could use the task `Start all but database` instead.

### Option 2

Expand Down

0 comments on commit 227f0dc

Please sign in to comment.