docs

Author: brunobritodev

docs/_static/css/custom.css

@@ -0,0 +1,19 @@
+kbd
+{
+  -moz-border-radius:3px;
+  -moz-box-shadow:0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
+  -webkit-border-radius:3px;
+  -webkit-box-shadow:0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
+  background-color:#f7f7f7;
+  border:1px solid #ccc;
+  border-radius:3px;
+  box-shadow:0 1px 0 rgba(0,0,0,0.2),0 0 0 2px #fff inset;
+  color:#333;
+  display:inline-block;
+  font-family:Arial,Helvetica,sans-serif;
+  font-size:11px;
+  line-height:1.4;
+  margin:0 .1em;
+  padding:.1em .6em;
+  text-shadow:0 1px 0 #fff;
+}

docs/conf.py

@@ -67,6 +67,7 @@
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
+highlight_language = 'csharp'
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -99,10 +100,19 @@
 
 
 # -- Options for HTMLHelp output ---------------------------------------------
+def setup(app):
+    app.add_stylesheet('css/custom.css')
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'JpProjectdoc'
 
+import os
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # -- Options for LaTeX output ------------------------------------------------
 

docs/images/multiple-startup-project.png

@@ -13,7 +13,7 @@ Helping teams and Entrepretneurs to achieve the company's primary purpose: Maxim
 Contributing
 ------------
 
-Wanna contribute? Check 
+Wanna contribute? Check the `Contributing Section <intro/contributing.html>`_
 
 Free
 ^^^^
@@ -33,11 +33,11 @@ There are several ways we can help you out.
 .. toctree::
    :maxdepth: 2
    :hidden:
-   :caption: GetStart
+   :caption: Get Start
 
-   quickstart/build
-   quickstart/ambient_variables
-   quickstart/docker_support
+   quickstarts/build.rst
+   quickstarts/ambient_variables.rst
+   quickstarts/docker_support
 
 
 .. toctree::

docs/index.rst

@@ -5,17 +5,17 @@ This project was developed aiming the best practices.
 
 Equinox Project
 ---------------
-To achieve this the ASP.NET Core Architecture was based on `Equinox Project <https://github.com/EduardoPires/EquinoxProject/>`_. 
+The ASP.NET Core Architecture was based on `Equinox Project <https://github.com/EduardoPires/EquinoxProject/>`_. 
 
 Angular 6
 ---------
 
-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.
+To manage existing 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.
 
 Application Insights ready
 --------------------------
 
-You can To monitor Application in production ambient with Application Insights.
+You can monitor Application in production ambient with Application Insights.
 
 
 Technologies
@@ -40,6 +40,7 @@ ASP.NET CORE
 * Event Sourcing
 * Unit of Work
 * Repository and Generic Repository
+* Serilog
 
 Angular 6
 ^^^^^^^^^^

docs/intro/architecture.rst

@@ -14,6 +14,6 @@ Please start a discussion on the `issue tracker <https://github.com/brunohbrito/
 
 Platform
 ^^^^^^^^
-JpProject is built against ASP.NET Core and runs on .NET Framework 4.6.1 (and higher) and .NET Core 2.1 (and higher).
+Backend of JpProject is built against ASP.NET Core and runs on .NET Framework 4.6.1 (and higher) and .NET Core 2.1 (and higher).
 
-SPA is built against Angular 6 and runs on Node and Angular Cli 6.
+The Frontend SPA is built against Angular 6 and runs on Node and Angular Cli 6.

docs/intro/contributing.rst

@@ -2,5 +2,5 @@
 Ambient variables
 #################
 
-Using Ambient var you can minimize efforts for publish and change configuration.
+Using Ambient var you can minimize efforts to change configuration after publish.
 

docs/quickstarts/ambient_variables.rst

@@ -0,0 +1,79 @@
+=========
+First Use
+=========
+
+In this section you will learn the basics to Get Ready!
+
+Pre-requisites
+--------------
+
+To build solution you need to certify about these components first
+
+* `.NET Core 2.1 <https://www.microsoft.com/net/download>`_
+* `node 8 <https://nodejs.org/en/>`_
+* npm 5
+* `Angular CLI 6.1 <https://github.com/angular/angular-cli/wiki>`_
+
+
+Build Files
+-----------
+
+After :download:`download <https://github.com/brunohbrito/JP-Project/archive/master.zip>` or `clone <https://github.com/brunohbrito/JP-Project>`_ the initial state of project is:
+
+* Use Sql Server LocalDb
+* Temporary Certificate
+* Auto Migration enabled
+
+Using build.bat
+^^^^^^^^^^^^^^
+
+Open folder *build* and execute build.bat. The file will install Nuget and NPM dependencies. Then compile and run.
+
+Using build.ps1
+^^^^^^^^^^^^^^
+
+Sometimes there are missing parameters at Environment Path, so the build.bat can't build. 
+
+Open powershell as Admin. Navigate to build folder. Execute these commands:
+
+* Set-ExecutionPolicy Unrestricted
+* .\build.ps1 
+* Set-ExecutionPolicy AllSigned
+
+.. raw:: html
+
+    <div style="position: relative; height: 0; overflow: hidden; max-width: 100%; height: auto;">
+        <iframe src="https://player.vimeo.com/video/288753436?color=ff9933&title=0&byline=0" width="800" height="600" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
+    </div>
+
+
+Using VS and VSCode
+--------------------
+
+The default way to Start the project.
+
+SSO and API
+^^^^^^^^^^^
+To load project open src/JpProject.sln vith Visual Studio. Now you need to set Multiple Startup Projects.
+
+.. image:: ../images/multiple-startup-project.png
+
+Run the project
+
+User Management
+^^^^^^^^^^^^^^^
+
+Open VSCode then go to File > Open Folder > Locate src\Frontend\Jp.UserManagement.
+
+Open Terminal :kbd:`CTRL` + :kbd:`'`. Type: 
+
+* npm install
+* ng serve
+
+Wait and open Browser at http://localhost:4200
+
+.. raw:: html
+
+    <div style="position: relative; height: 0; overflow: hidden; max-width: 100%; height: auto;">
+        <iframe src="https://player.vimeo.com/video/288762840?color=ff9933&title=0&byline=0" width="800" height="600" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
+    </div>

docs/quickstarts/build.rst

@@ -1,7 +1,6 @@
 param (
     [Parameter(Mandatory=$true)][string]$certificatename,
-    [Parameter(Mandatory=$true)][SecureString]$certificatepassword,
-    [Parameter(Mandatory=$true)][string]$path
+    [Parameter(Mandatory=$true)][SecureString]$certificatepassword
  )
 # setup certificate properties including the commonName (DNSName) property for Chrome 58+
 $certificate = New-SelfSignedCertificate `
@@ -18,7 +17,7 @@ $certificate = New-SelfSignedCertificate `
     -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.1") 
 $certificatePath = 'Cert:\CurrentUser\My\' + ($certificate.ThumbPrint)
 # create temporary certificate path
-$tmpPath = $path
+$tmpPath = (Get-Item -Path ".\" -Verbose).FullName;
 If(!(test-path $tmpPath))
 {
 New-Item -ItemType Directory -Force -Path $tmpPath