From 34f77ddfbc83ce398937e83dea4df19a6308a488 Mon Sep 17 00:00:00 2001 From: Mukesh Murugan <31455818+iammukeshm@users.noreply.github.com> Date: Fri, 25 Dec 2020 16:59:13 +0530 Subject: [PATCH] Update README.md --- README.md | 45 +++++++-------------------------------------- 1 file changed, 7 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index b0385b2..c8f58b8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ # Clean Architecture Boilerplate - ASP.NET Core 5.0 (WebApi & MVC) Clean Architecture Solution Template for ASP.NET Core 5.0. Built with Onion/Hexagonal Architecture and incorporates the most essential Packages your projects will ever need. Includes both WebApi and Web(MVC) Projects. -# Coming Soon. -Will be soon available at the Nuget Store. +# V1.0.0 is Released. + +[Get the NuGet Package from here!](https://www.nuget.org/packages/AspNetCoreHero.Boilerplate/) + +[Getting Started - Quick Start Guide](https://codewithmukesh.com/blog/aspnet-core-hero-boilerplate-quick-start-guide/) + +[View the Project Page](https://codewithmukesh.com/project/aspnet-core-hero-boilerplate/) # The Vision @@ -19,42 +24,6 @@ How easy would it be if you are able to run a single line of CLI command on your If you found this Implementation helpful or used it in your Projects, do give it a star. Thanks! Or, If you are feeling really generous, [Support the Project with a small contribution!](https://www.buymeacoffee.com/codewithmukesh) -## Quick Start Guide -Since the project is still under developement, the CLI features are not yet available. Although you can clone / fork / download the repository and execute it locally on your machine. Here are the steps involed. -1. Download / Fork this Repository -2. Open up the Solution File in Visual Studio 2019 (v16.8+) . Make sure you have the .NET 5 SDK installed. -3. Give it a few moment for the solution to restore all the required packages from NuGet store. -4. Open up appsettings.json on each of the WebAPI and MVC Project. Make sure to update the Connection strings with valid ones. -5. Open up Package Manager Console. - 1. Set the API Project as the Startup Project. - 2. Set the Infrastructure Project as the Default project. (You can typically find this dropdown on the Package Manager Console tab somewhere on the top corner) - 3. Run the following commands to add migrations(if any). - ``` - add-migration initialbuild -context ApplicationDbContext - add-migration initialbuild -context IdentityContext - ``` - 4. Next, let's update our database with the newly created migrations. - ``` - update-database -context ApplicationDbContext - update-database -context IdentityContext - ``` -6. That's almost everything you will have to do to get started with this project. More details will be posted once the Project is at it's pre-production stage. Cheers! - -### Default Roles & Credentials -As soon you build and run your Awesome Application, default users and roles get added to the database. - -Default Roles are as follows. -- SuperAdmin -- Admin -- Moderator -- Basic - -Here are the credentials for the default users. -- Email - superadmin@gmail.com / Password - 123Pa$$word! -- Email - basic@gmail.com / Password - 123Pa$$word! - -You can use these default credentials to generate valid JWTokens at the ../api/account/authenticate endpoint. - ## Features Included ### ASP.NET Core 5.0 MVC Project