Add project Readme.md

ravi-shiva · Feb 26, 2020 · b6358cc · b6358cc
1 parent 1c58b21
commit b6358cc
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 9 deletions.
diff --git a/ContosoUniversity.Api.Tests/ApiIntegrationTests.cs b/ContosoUniversity.Api.Tests/ApiIntegrationTests.cs
@@ -7,7 +7,7 @@ namespace ContosoUniversity.Api.Tests
 {
  public class ApiIntegrationTests : BaseIntegrationTest<Startup>
  {
- [Fact]
+ [Fact(Skip = "Move to separate project")]
  public async Task DepartmentApi_ReturnsArrayOfDepartmentObjects()
  {
  var url = "/Departments";

diff --git a/ContosoUniversity.Api.Tests/Readme.md b/ContosoUniversity.Api.Tests/Readme.md
@@ -0,0 +1,8 @@
+## ContosoUniversity.Api.Tests
+
+### Run tests
+```
+git clone https://github.com/alimon808/contoso-university.git
+cd ContosoUniversity.Api.Tests
+dotnet test
+```
diff --git a/ContosoUniversity.Api/Readme.md b/ContosoUniversity.Api/Readme.md
@@ -0,0 +1,8 @@
+## ContosoUniversity.Api
+
+### Run Api with Swagger UI
+```
+git clone https://github.com/alimon808/contoso-university.git
+cd ContosoUniversity.Api
+dotnet run
+```
diff --git a/ContosoUniversity.Common/Readme.md b/ContosoUniversity.Common/Readme.md
@@ -0,0 +1,3 @@
+### ContosoUniversity.Common
+
+Shared library between Api and Web projects
diff --git a/ContosoUniversity.Data.Tests/Readme.md b/ContosoUniversity.Data.Tests/Readme.md
@@ -0,0 +1,9 @@
+## ContosoUniversity.Data.Tests
+Test project for ContosoUniversity.Data.
+
+### Run tests
+```
+git clone https://github.com/alimon808/contoso-university.git
+cd ContosoUniversity.Data.Tests
+dotnet test
+```
diff --git a/ContosoUniversity.Data/Readme.md b/ContosoUniversity.Data/Readme.md
@@ -0,0 +1 @@
+### ContosoUniversity.Data (WIP)
diff --git a/ContosoUniversity.Spa.React/ReadMe.md b/ContosoUniversity.Spa.React/ReadMe.md
@@ -1,12 +1,13 @@
-## Contoso University - React using JavaScriptServices
+## ContosoUniversity.Spa.React
+Single Page Application (SPA) using React front-end framework and WebApi backend
 
 ### Prerequisites
-- .NET Core SDK v2.0.0 or later
+- .NET Core SDK v2.1.0 or later
 - Node.js v6.0 or later
 
-Building the app: `dotnet build`
-
-Running the app: `dotnet run`, navigate to http:https://localhost:5000
-
-
-[Demo](https://contoso-university-demo-react.azurewebsites.net/)
+### Run App
+```
+git clone https://github.com/alimon808/contoso-university.git
+cd ContosoUniversity.Spa.React
+dotnet run
+```
diff --git a/ContosoUniversity.Web.Tests/Readme.md b/ContosoUniversity.Web.Tests/Readme.md
@@ -0,0 +1,9 @@
+## ContosoUniversity.Web.Test
+Unit test project for [ContosoUniversity.Web](https://github.com/alimon808/contoso-university/tree/master/ContosoUniversity.Web)
+
+### Run tests
+```
+git clone https://github.com/alimon808/contoso-university.git
+cd ContosoUniversity.Web.Test
+dotnet test
+```
diff --git a/ContosoUniversity.Web/Readme.md b/ContosoUniversity.Web/Readme.md
@@ -0,0 +1,8 @@
+## ContosoUniversity.Web
+
+### Run Mvc App
+```
+git clone https://github.com/alimon808/contoso-university.git
+cd ContosoUnversity.Web
+dotnet run
+```