Update README.md

This commit is contained in:
Muhammad Azeez 2021-01-18 18:23:33 +03:00 committed by GitHub
parent aaee792ae2
commit 0071321f50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,13 +2,13 @@
This is an early look of what the future of authentication might look like for citizens and employees in Kurdistan. This is an early look of what the future of authentication might look like for citizens and employees in Kurdistan.
**DISCLAIMER:** This is by no means a production-grade system. This was done in a short time and is only meant for demoing the Authorization Server. We are NOT using best practices everywhere in an effort to put something together as soon as possible. **DISCLAIMER:** We are NOT using best practices in many places in an effort to put something together as quickly as possible. This is only meant as a demo.
## Components ## Components
### IdentityServer 4 ### IdentityServer 4
We are using IdentityServer 4 to implement our Authorization Server. You can find the source code here. We are using IdentityServer 4 to implement our Authorization Server. You can find [the source code here](./CSharp/OidcSamples/OidcSamples.AuthorizationServer).
**URL:** http://localhost:10000 **URL:** http://localhost:10000
@ -25,7 +25,7 @@ dotnet run
### Traffic Police React App ### Traffic Police React App
This is a react SPA that allows citizens to manage their registered vehicles. It talks to the Traffic Police API to get and update data. This is a react SPA that allows citizens to manage their registered vehicles. It talks to the Traffic Police API to get and update data. You can find [the source code here](./React/traffic-police).
**URL:** http://localhost:3000 **URL:** http://localhost:3000
@ -46,7 +46,7 @@ npm start
### Traffic Police API ### Traffic Police API
This is an ASP.NET Core API that talks to a PostgreSQL database. This is an ASP.NET Core API that talks to a PostgreSQL database. You can find [the source code here](./CSharp/OidcSamples/OidcSamples.TrafficPoliceApi).
**URL:** http://localhost:9000 **URL:** http://localhost:9000
@ -56,6 +56,7 @@ This is an ASP.NET Core API that talks to a PostgreSQL database.
- Authorization Server - Authorization Server
- PostgreSQL - PostgreSQL
- [.NET Core EF CLI](https://docs.microsoft.com/en-us/ef/core/cli/dotnet) - [.NET Core EF CLI](https://docs.microsoft.com/en-us/ef/core/cli/dotnet)
- [Microsoft.AspNetCore.Authentication.JwtBearer](https://www.nuget.org/packages/Microsoft.AspNetCore.Authentication.JwtBearer)
**How to run:** **How to run:**
@ -68,7 +69,7 @@ dotnet run
### Real Estate React App ### Real Estate React App
This is a react SPA that allows citizens to manage their registered real estate. It talks to the Real Estate API to get and update data. This is a react SPA that allows citizens to manage their registered real estate. It talks to the Real Estate API to get and update data. You can find [the source code here](./React/real-estate).
**URL:** http://localhost:4000 **URL:** http://localhost:4000
@ -122,6 +123,26 @@ npm install
node index.js node index.js
``` ```
### Tax ASP.NET Core App
This is a server-side app using ASP.NET Core Razor Pages. It talks to the Traffic Police API and Real Estate API to calculate taxes. You can find [the source code here](./CSharp/OidcSamples/OidcSamples.TaxApp).
**URL:** http://localhost:7000
**Dependencies:**
- Authorization Server
- Traffic Police API
- Real Estate API
- [Microsoft.AspNetCore.Authentication.OpenIdConnect](https://www.nuget.org/packages/Microsoft.AspNetCore.Authentication.OpenIdConnect)
**How to run:**
```
cd ./CSharp/OidcSamples/OidcSamples.OidcSamples.TaxApp
dotnet run
```
## Notes ## Notes
1. The APIs assume that the PostgreSQL database instance is on localhost and the username is `postgres` and password is `root`. If it's different, then you have to configure the APIs with the correct credentials. 1. The APIs assume that the PostgreSQL database instance is on localhost and the username is `postgres` and password is `root`. If it's different, then you have to configure the APIs with the correct credentials.