Skip to content

Commit

Permalink
LICENSE + Update README (#57)
Browse files Browse the repository at this point in the history
* add MIT license
* update README
  • Loading branch information
skrasekmichael authored May 16, 2024
1 parent 55d6540 commit 5c39a9f
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
7 changes: 7 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright (c) 2024 Michael Škrášek

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Clean Architecture Backend
The **Clean Architecture** Backend developed with **Domain-Driven Design** and **CQRS**.
This is a backend for a demonstration application *"TeamUp"* (team managment application) as part of my **Master's Thesis** at [BUT FIT](https://www.fit.vut.cz/.en).

### Run

```bash
# with dotnet 8 sdk
dotnet run --project src/TeamUp.Api
```
By default, the application launches at *https://localhost:7089* by default, to change the port, change the `applicationUrl` value in `src/TeamUp.Api/Properties/launchSettings.json`.

#### Database
By default, the application expects postgres database instance running at localhost (port 5432), and logs in using `postgres` username and `devpass` password. To change that, change connection string in `Database` section in `src/TeamUp.Api/appsettings.json`.

Such instance can be launched using the [scripts/rundb.ps1](scripts/rundb.ps1) script.

#### Client
By default, the application expects the client app ([frontend](https://github.com/skrasekmichael/ModularInformationSystemFrontend)) at *https://localhost:7229*, to change that, change the `Url` value in `Client` section in `src/TeamUp.Api/appsettings.json`.

0 comments on commit 5c39a9f

Please sign in to comment.