Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iammukeshm authored Dec 25, 2020
1 parent 6b41a4f commit 34f77dd
Showing 1 changed file with 7 additions and 38 deletions.
45 changes: 7 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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 - [email protected] / Password - 123Pa$$word!
- Email - [email protected] / 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
Expand Down

0 comments on commit 34f77dd

Please sign in to comment.