Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bradymholt/aspnet-core-react-template

ASP.NET Core 3.1 / React SPA Template App
https://github.com/bradymholt/aspnet-core-react-template

ansible asp-net-core dotnet-core mailcatcher openiddict postgresql-database postgressql react-template reactjs spa

Last synced: about 2 months ago
JSON representation

ASP.NET Core 3.1 / React SPA Template App

Awesome Lists containing this project

README 

        
# ASP.NET Core / React SPA Template App










  **Would you take a quick second and ⭐️ my repo?**







This app is a template application using ASP.NET Core 3.1 for a REST/JSON API server and React for a web client.



![screen recording 2017-06-10 at 04 12 pm](https://user-images.githubusercontent.com/759811/27006360-bd3b8152-4df7-11e7-9011-f22204abe4d5.gif)



## Overview of Stack

- Server

  - ASP.NET Core 3.1

  - PostgreSQL 10

  - Entity Framework Core w/ EF Migrations

  - JSON Web Token (JWT) authorization

  - Docker used for development PostgreSQL database and MailCatcher server

- Client

  - React 16

  - Webpack for asset bundling and HMR (Hot Module Replacement)

  - CSS Modules

  - Fetch API for REST requests

- Testing

  - xUnit for .NET Core

  - Enzyme for React

  - MailCatcher for development email delivery

- DevOps

  - Ansible playbook for provisioning (Nginx reverse proxy, SSL via Let's Encrypt, PostgreSQL backups to S3)

  - Ansible playbook for deployment



## Demo



[![Demo Video](https://cloud.githubusercontent.com/assets/759811/26319096/4075a7e2-3ee3-11e7-8017-26df7b278b27.png)](https://www.youtube.com/watch?v=xh5plRGg3Nc)



## Setup



1. Install the following:

   - [.NET Core 3.1](https://www.microsoft.com/net/core)

   - [Node.js >= v8](https://nodejs.org/en/download/)

   - [Ansible >= 2.6](http://docs.ansible.com/ansible/intro_installation.html)

   - [Docker](https://docs.docker.com/engine/installation/)

2. Run `npm install && npm start`

3. Open browser and navigate to [http://localhost:5000](http://localhost:5000).



This template was developed and tested on macOS Sierra but should run on Windows (for development) as well.  If you experience any issues getting it to run on Windows and work through them, please submit a PR!  The production provisioning and deployment scripts (`provision:prod` and `deploy:prod`) use Ansible and require a Linux/Ubuntu >= 16.04 target host.



## Scripts



### `npm install`



When first cloning the repo or adding new dependencies, run this command.  This will:



- Install Node dependencies from package.json

- Install .NET Core dependencies from api/api.csproj and api.test/api.test.csproj (using dotnet restore)



### `npm start`



To start the app for development, run this command.  This will:



- Run `docker-compose up` to ensure the PostgreSQL and MailCatcher Docker images are up and running

- Run `dotnet watch run` which will build the app (if changed), watch for changes and start the web server on http://localhost:5000

- Run Webpack dev middleware with HMR via [ASP.NET JavaScriptServices](https://github.com/aspnet/JavaScriptServices)



### `npm run migrate`



After making changes to Entity Framework models in `api/Models/`, run this command to generate and run a migration on the database.  A timestamp will be used for the migration name.



### `npm test`



This will run the xUnit tests in api.test/ and the Mocha/Enzyme tests in client-react.test/.



### `npm run provision:prod`



 _Before running this script, you need to create an ops/config.yml file first.  See the [ops README](ops/) for instructions._



 This will run the ops/provision.yml Ansible playbook and provision hosts in ops/hosts inventory file.  Ubuntu 16.04 (Xenial) and Ubuntu 18.04 (Bionic) is supported and tested.



 This prepares the hosts to recieve deployments by doing the following:

  - Install Nginx

  - Generate a SSL certificate from [Let's Encrypt](https://letsencrypt.org/) and configure Nginx to use it

  - Install .Net Core

  - Install Supervisor (will run/manage the ASP.NET app)

  - Install PostgreSQL

  - Setup a cron job to automatically backup the PostgreSQL database, compress it, and upload it to S3.

  - Setup UFW (firewall) to lock everything down except inbound SSH and web traffic

  - Create a deploy user, directory for deployments and configure Nginx to serve from this directory



### `npm run deploy:prod`



_Before running this script, you need to create a ops/config.yml file first.  See the [ops README](ops/) for instructions._



This script will:

 - Build release Webpack bundles

 - Package the .NET Core application in Release mode (dotnet publish)

 - Run the ops/deploy.yml Ansible playbook to deploy this app to hosts in /ops/config.yml inventory file.



 This does the following:

  - Copies the build assets to the remote host(s)

  - Updates the `appsettings.json` file with PostgreSQL credentials specified in ops/group_vars/all file and the app URL (needed for JWT tokens)

  - Restarts the app so that changes will be picked up



 Entity Framework Migrations are [automatically applied upon startup](https://github.com/bradymholt/aspnet-core-react-template/blob/master/api/Program.cs#L23-L24) so they will run when the app restarts.



## Development Email Delivery



This template includes a [MailCatcher](https://mailcatcher.me/) Docker image so that when email is sent during development (i.e. new user registration), it can be viewed

in the MailCacher web interface at [http://localhost:1080/](http://localhost:1080/).



## Older Versions



This template was originally created on .NET Core 1.0 and has been upgraded with new versions of .NET Core.  Older versions can be found on the [Releases](https://github.com/bradymholt/aspnet-core-react-template/releases) page.



## Visual Studio Code config



This project has [Visual Studio Code](https://code.visualstudio.com/) tasks and debugger launch config located in .vscode/.



### Tasks



- **Command+Shift+B** - Runs the "build" task which builds the api/ project

- **Command+Shift+T** - Runs the "test" task which runs the xUnit tests in api.test/ and Mocha/Enzyme tests in client-react.test/.



### Debug Launcher



With the following debugger launch configs, you can set breakpoints in api/ or the the Mocha tests in client-react.test/ and have full debugging support.



- **Debug api/ (server)** - Runs the vscode debugger (breakpoints) on the api/ .NET Core app

- **Debug client-react.test/ (Mocha tests)** - Runs the vscode debugger on the client-react.test/ Mocha tests



## Credit



The following resources were helpful in setting up this template:



- [Sample for implementing Authentication with a React Flux app and JWTs](https://github.com/auth0-blog/react-flux-jwt-authentication-sample)

- [Angular 2, React, and Knockout apps on ASP.NET Core](http://blog.stevensanderson.com/2016/05/02/angular2-react-knockout-apps-on-aspnet-core/)

- [Setting up ASP.NET v5 (vNext) to use JWT tokens (using OpenIddict)](http://capesean.co.za/blog/asp-net-5-jwt-tokens/)

- [Cross-platform Single Page Applications with ASP.NET Core 1.0, Angular 2 & TypeScript](https://chsakell.com/2016/01/01/cross-platform-single-page-applications-with-asp-net-5-angular-2-typescript/)

- [Stack Overflow - Token Based Authentication in ASP.NET Core](http://stackoverflow.com/questions/30546542/token-based-authentication-in-asp-net-core-refreshed)

- [SPA example of a token based authentication implementation using the Aurelia front end framework and ASP.NET core]( https://github.com/alexandre-spieser/AureliaAspNetCoreAuth)

- [A Real-World React.js Setup for ASP.NET Core and MVC5](https://www.simple-talk.com/dotnet/asp-net/a-real-world-react-js-setup-for-asp-net-core-and-mvc)

- [Customising ASP.NET Core Identity EF Core naming conventions for PostgreSQL](https://andrewlock.net/customising-asp-net-core-identity-ef-core-naming-conventions-for-postgresql)

- My own perseverance because this took a _lot_ of time to get right 🤓