https://github.com/gsa/asp-.net-core-template

ASP .NET Core Project Template
https://github.com/gsa/asp-.net-core-template

asp-net-core dotnet-core entity-framework-core postgresql project-template template visual-studio

Last synced: about 1 year ago
JSON representation

ASP .NET Core Project Template

• Host: GitHub
• URL: https://github.com/gsa/asp-.net-core-template
• Owner: GSA
• Created: 2018-07-31T16:02:42.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-09-20T14:53:08.000Z (almost 4 years ago)
• Last Synced: 2025-04-03T04:51:09.647Z (about 1 year ago)
• Topics: asp-net-core, dotnet-core, entity-framework-core, postgresql, project-template, template, visual-studio
• Language: SCSS
• Size: 54 MB
• Stars: 8
• Watchers: 3
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# ASP .NET Core Project Template

ASP .NET Core Project Template for GSA FM IT team.  Every one should be able to use this templae to build a ASP .NET Core web app with PostgreSQL database and beautifully looking U.S. Web Deisgn Standard UI. 

### Key Functions 

1. Landing page design with [U.S. Web Deisgn System 2](https://designsystem.digital.gov).

2. Cross-platform.

3. Sing-in pgae exmaple.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

- Visual Studio 2022 or higher 

- .NET 6.x SDK  

- Npgsql.EntityFrameworkCore.PostgreSQL 2.1.1.1 (https://www.nuget.org/packages/Npgsql.EntityFrameworkCore.PostgreSQL/)

### Installing

1. Download and copy to \My Documents\Visual Studio 2017\Templates\ProjectTemplates folder.

### Using the Template for a New Project

1. Launch Visual Studio 2019 and create a new project. Use the "ASP.NET Core Web Application" template (C#). Use a unique name for the new project.

2. In the "Create a new ASP.NET Core web application" window, select ".NET Core" and "ASP.NET Core 3.1" in the dropdown menus. Choose the "Empty" project type and Check the "Configure for HTTPS" box. Click "Create".

3. Once the project has been created, close Visual Studio.

4. Clone this repository to a new folder.

5. Remove *all* of the files and folders from within your project's web root. This includes the following:

    - *bin/*

    - *obj/*

    - *Properties/*

    - *appsettings.Development.json*

    - *appsettings.json*

    - *Program.cs*

    - *Startup.cs*

6. Copy *all* files and folders from this repository's **2nd** *ASP Core MVC Template* subdirectory and paste them into the same location within your own project. You're replacing all of the files you removed in the previous step.

7. Rename the *ASP Core MVC Template.csproj* file to your own project's name. Edit it with an app like *Notepad* and make the following changes:

    - Replace the *\* value with your project's namespace.

8. Rename the *ASP Core MVC Template.csproj.user* file to your own project's name.

9. Rename the *ASP_CORE_MVC_Template_appsettings_Example.json* file to *\_appsettings.json*.

10. Copy *\_appsettings.json* to the folder you assigned to the *APPSETTINGS_DIRECTORY* environment variable (as described earlier in this readme).

11. Edit *AssemblyInfo.cs* as follows:

    - Replace the *RootNamespace* value with your project's namespace.

12. Edit *Program.cs* as follows:

    - Change *namespace ASP_Core_MVC_Template* to *namespace \*

    - Change *config.AddJsonFile("ASP_Core_MVC_Template_appsettings.json")* to *config.AddJsonFile("\_appsettings.json")*

13. Edit *Startup.cs* as follows:

    - Change *namespace ASP_Core_MVC_Template* to *namespace \*

    - Change *options.Cookie.Name = ".Core-Web-Template.Session";* to *options.Cookie.Name = ".\.Session";*

    - Change *loggerFactory.AddFile(logDirectory + "/Core-Web-Template-{Date}.log");* to *loggerFactory.AddFile(logDirectory + "/\-{Date}.log");*

    - Change *app.UsePathBase("/core-web");* to *app.UsePathBase("/\");* (make sure you **preserve all lowercase** for this change!)

14. Remove all *bin\\Debug\\netcoreapp3.1\\ASP Core MVC Template.\** files.

15. Edit *Controllers\\HomeControler.cs* as follows:

    - Change *using ASP_Core_MVC_Template.Models;* to *using \.Models;*

    - Change *namespace ASP_Core_MVC_Template.Controllers* to *namespace \.Controllers*

    - If using *AppStatus* functionality from *CAAM*, change *_configService.GetAppClosed("CORE_TEMPLATE");* to *_configService.GetAppClosed("\");*

    - If using *AppStatus* functionality from *CAAM*, change *_configService.GetAppWarning("CORE_TEMPLATE");* to *_configService.GetAppWarning("\");*

    - If using roles from *CAAM*, edit the *\[Authorize(Roles = "COREADMIN,COREUSER")\]* line to use roles that are applicable to your project.

16. Edit *Controllers\\LoginControler.cs* as follows:

    - Change *namespace ASP_Core_MVC_Template.Controllers* to *namespace \.Controllers*

    - If using roles from *CAAM*, edit *_dataAPIService.GetCAAMRoles("Core Template"* to *_dataAPIService.GetCAAMRoles("\"*

17. Edit *Models\\ErrorViewModel.cs* as follows:

    - Change *namespace ASP_Core_MVC_Template.Models* to *namespace \.Models*

18. If using roles from *CAAM*, edit *Views\\Home\\LoggedIn.cshtml* as follows:

    - Change *Context.User.IsInRole("COREADMIN")* to use a role applicable to your project.

19. Edit *Views\\Home\\Warning.cshtml* as follows:

    - Change *\Warning - CAAM Web Template\* to *\Warning - \\*

20. Edit *Views\\Shared\\\_Layout.cshtml* as follows:

    - Change *@ViewData\["Title"\] - Core Web Template* to *@ViewData["Title"] - \*

    - Change *aria-label="Home"\>Core Web Template* to *aria-label="Home"\>\*

21. Edit *Views\\\_ViewImports.cshtml* as follows:

    - Change both instances of *@using ASP_Core_MVC_Template* to *@using \*