Skip to content
This repository was archived by the owner on Aug 1, 2021. It is now read-only.

Commit 1fb5627

Browse files
committed
docks
1 parent 4b1a561 commit 1fb5627

7 files changed

Lines changed: 90 additions & 16 deletions

File tree

docs/.vscode/settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"restructuredtext.confPath": "d:\\workspace\\JP.Project\\docs"
2+
"restructuredtext.confPath": "d:\\workspace\\JpProject\\docs"
33
}

docs/autobuild.bat

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
sphinx-autobuild . _build/html

docs/images/ddd.png

297 KB
Loading

docs/index.rst

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Welcome to Jp Project's documentation!
2-
======================================
1+
Getting Started
2+
===============
33

44
.. image:: images/logo.png
55
:align: center
@@ -11,7 +11,8 @@ The main goal of project is to be a Management Ecosystem for IdentityServer4. He
1111
Helping teams and Entrepretneurs to achieve the company's primary purpose: Maximize shareholder value.
1212

1313
Contributing
14-
^^^^^^^^^^^^^^
14+
------------
15+
1516
Wanna contribute? Make a pull request!
1617

1718
Free
@@ -25,25 +26,25 @@ There are several ways we can help you out.
2526
:hidden:
2627
:caption: Introduction
2728

28-
intro/big_picture
29-
intro/architecture
30-
intro/technologies
29+
intro/big_picture
30+
intro/architecture
3131

3232
.. toctree::
3333
:maxdepth: 2
3434
:hidden:
35-
:caption: Setup
35+
:caption: Building
3636

37-
setup/ambient_variables
38-
setup/docker_support
39-
setup/building
37+
quickstart/build
38+
quickstart/ambient_variables
39+
quickstart/docker_support
40+
4041

4142
.. toctree::
4243
:maxdepth: 2
4344
:hidden:
4445
:caption: Configuration
4546

46-
configuration/sql_server
47-
configuration/mysql
48-
configuration/serilog
49-
configuration/application_insights
47+
configuration/sql_server
48+
configuration/mysql
49+
configuration/serilog
50+
configuration/application_insights

docs/intro/architecture.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
Architecture
2+
============
3+
4+
This project was developed aiming the best practices.
5+
6+
Equinox Project
7+
---------------
8+
To achieve this the ASP.NET Core Architecture was based on `Equinox Project <https://github.com/EduardoPires/EquinoxProject/>`_.
9+
10+
Angular 6
11+
---------
12+
13+
To manage user and new one's a SPA Angular 6 was created. But instead begin of nothing, the `CoreUI <https://github.com/coreui/coreui-angular>`_ Admin was used.
14+
15+
Application Insights ready
16+
--------------------------
17+
18+
You can To monitor Application in production ambient with Application Insights.
19+
20+
21+
Technologies
22+
-------------
23+
24+
These Technologies was used to build app
25+
26+
DDD
27+
^^^
28+
29+
.. image:: ../images/ddd.png
30+
31+
32+
ASP.NET CORE
33+
^^^^^^^^^^^^
34+
35+
* Full architecture with responsibility separation concerns, SOLID and Clean Code
36+
* Domain Driven Design (Layers and Domain Model Pattern)
37+
* Domain Events
38+
* Domain Notification
39+
* CQRS (Imediate Consistency)
40+
* Event Sourcing
41+
* Unit of Work
42+
* Repository and Generic Repository
43+
44+
Angular 6
45+
^^^^^^^^^^
46+
47+
* OpenId Connect throug angular-oauth2-oidc plugin to manage login.
48+
* Bootstrap 4
49+
* angular-6-social-login-v2 to take profile from Google and Facebook before register new users

docs/intro/big_picture.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
11
Overview
2-
================================
2+
========
33

44
An overview about current devlopment
55

66
.. image:: ../images/bigpicture.JPG
7+
8+
SSO
9+
---
10+
11+
It's responsible for Authenticate users. Check it's credentials and emit Tokens for Applications.
12+
Authentication is needed when an application needs to know the identity of the current user. Typically these applications manage data on behalf of that user and need to make sure that this user can only access the data for which he is allowed.
13+
14+
Click `here <http://docs.identityserver.io/en/release/intro/big_picture.html#authentication>`_ to check more details.
15+
16+
User Management UI
17+
------------------
18+
19+
A SPA application responsible for create and manager users. Send reset links. E-mail validation. Profile validation, and so on.
20+
21+
User Management API
22+
-------------------
23+
24+
This API serve UI.

docs/quickstart/build.srt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Build
2+
=======
3+
4+
In this section you will learn the basics to Get Ready!
5+

0 commit comments

Comments
 (0)