AdminPLUS

.NET Core 5 Starter Admin Template

• created: 10/28/2020
• latest update: 11/21/2020
• by: Sangib Kumar Saha
• email: sangibruse@gmail.com

Thank you for purchasing my script. If you have any questions that are beyond the scope of this help file, feel free to email me.

• VS Code or Visual Studio 2019.
• Database provider software (SQL Server/MySql/Sqlite/PostgreSql/Oracle).

For Admin access, Username:admin@2020 Password:admin@2020

For User access, Username:user@2020 Password:user@2020

• Open AdminApi project on Visual studio code or Visual Studio 2019.On appsettings.json file you will find five connection strings for five different database connectivity. Replace the connection string by your one.

"ConnectionStrings": {

    "ApiConnStringMssql": "data source=Sangib-PC;initial catalog=AdminDB;
     persist security info=True;Integrated Security=SSPI;",

    "ApiConnStringMysql": "server=localhost;port=3306;database=AdminDB;user=root;",

    "ApiConnStringOracle": "Data Source=(DESCRIPTION=(ADDRESS_LIST=
    (ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521)))  
    (CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=orclpdb)));User Id=root;Password=root;",

    "ApiConnStringSqlite": "Data Source=AdminDB.db;",

    "ApiConnStringPostgreSql": "Server=127.0.0.1;Port=5432;Database=AdminDB;
    User Id=postgres;Password=postgres;"

  }

• Then open Startup.cs file, On ConfigureServices method you will see five AppDbContextPool for five Connection Strings that already have on appsettings.json file. Un-Comment your required one and keep other four as commented.Have a look to the below code.I only un-comment the Mysql portion because i used Mysql DB here.

public void ConfigureServices(IServiceCollection services)

        {
            //Sql Server Connection String
            /* services.AddDbContextPool<AppDbContext>(opt => opt.UseSqlServer
            (Configuration.GetConnectionString("ApiConnStringMssql"))); */


            //Mysql Connection String
            services.AddDbContextPool<AppDbContext>(opt=>opt.UseMySql
            (Configuration.GetConnectionString("ApiConnStringMysql")));

            //Sqlite Connection String
            /* services.AddDbContextPool<AppDbContext>(opt=>opt.UseSqlite
            (Configuration.GetConnectionString("ApiConnStringSqlite"))); */


            //PostgreSql Connection String
            /* services.AddDbContextPool<AppDbContext>(opt=>opt.UseNpgsql
            (Configuration.GetConnectionString("ApiConnStringPostgreSql"))); */


            //Oracle Connection String
            /* services.AddDbContextPool<AppDbContext>(opt=>opt.UseOracle
            (Configuration.GetConnectionString("ApiConnStringOracle"))); */ 

• Now Open terminal on VS Code(for Visual Studio 2019 Tools -> Command Line -> Developer Command Prompt and switch to your project directory) and write below commands     

               ->dotnet ef migrations add <MigrationName>

               ->dotnet ef database update

               ->dotnet run

• After successful build a folder named Migrations should create to user project structure and a database named   AdminDB  should create with seed data to your MySQL server (if you use MSSQL then you should check to Sql Server and so on for other databases). After executing "dotnet run" command you should see that your API listening at http://localhost:5001/.Navigate to the link to see the swagger Api documentation UI.

• You can check Api by Swagger UI by navigating http://localhost:5001/.First go to the method /api/Users/GetLoginInfo/{username}/{password} then enter username and password as i mentioned eairlier, a token will be generated here. Use this token to authorize the api by clicking the Authorize button at the top right and header value format example: "Bearer TokenText". Then you will able to check all the methods as expected.

• You can change token expire time from UsersController GenerateJwtToken method.Currently it is set to 180 minutes.

        string GenerateJwtToken(UserInfo userInfo)
        {
            var securityKey=new SymmetricSecurityKey(Encoding.UTF8.GetBytes
                           (_config["Jwt:SecretKey"]));
            var credentials = new SigningCredentials(securityKey, 
                              SecurityAlgorithms.HmacSha256);
            var claims = new[]
            {
                new Claim(JwtRegisteredClaimNames.Sub, userInfo.UserId.ToString()),
                new Claim("fullName", userInfo.FullName.ToString()),
                new Claim("role",userInfo.RoleName),
                new Claim(JwtRegisteredClaimNames.Jti, Guid.NewGuid().ToString()),
            };
            var token = new JwtSecurityToken(
                issuer: _config["Jwt:Issuer"],
                audience: _config["Jwt:Audience"],
                claims: claims,
                expires: DateTime.Now.AddMinutes(180),
                signingCredentials: credentials
            );
            return new JwtSecurityTokenHandler().WriteToken(token);
        }                                                                    

• After first migration all the project specific data will insert to your underlying database through your Models->AppDBContext.cs class OnModelCreating Seed (for Oracle use SeedOracle()) method.

        protected override void OnModelCreating(ModelBuilder modelBuilder)   
        {   
            modelBuilder.Seed();//use this for Sql server,Mysql,Sqlite and PostgreSql
           //modelBuilder.SeedOracle();//use this only for Oracle
        }

• This project used database driven role based authorization. Through migration data you will get two roles, named Admin and User. You can add more role from Role List menu after running the Client project. These role names are used in Authorize attribute on Api project as role name to authorize that particular method. 

• Open AdminClient on Visual Studio 2019 or Visual Studio Code. Run the project either command line or debugging mode (pressing F5 or Ctrl+F5). In command line mood the Client project will run at http://localhost:5000 and in debugging mood it will run at http://localhost:53580.

• Now open appsettings.json file, you should see a string named WebAPIBaseUrl here which is set to http://localhost:5001. Actually our AdminApi project is running here. 

{
  "Logging": {
    "Debug": {
      "LogLevel": {
        "Default": "Warning",
        "AdminClient.Controllers.ErrorController": "Warning",
        "AdminClient.Controllers.HomeController": "Warning",
        "Microsoft": "Warning"
      }
    },
    "LogLevel": {
      "Default": "Trace",
      "AdminClient.Controllers.ErrorController": "Trace",
      "AdminClient.Controllers.HomeController": "Trace",
      "Microsoft": "Warning"
    }
  },
  "AllowedHosts": "*",
  "WebAPIBaseUrl": "http://localhost:5001"
}

• Currently the session time is set to 60 minute. You may change it from Startup.cs class. 

public void ConfigureServices(IServiceCollection services)
        {
            services.AddSession(options =>
            {
                options.IdleTimeout = TimeSpan.FromMinutes(60);
            });
            services.AddControllersWithViews();          
        }

• The Client project uses NLog (a 3rd party loggger service) to generate a log text file every day for errors and exceptions that occurs when using. You will find those file on your Windows OS C Drive and the file location is C:\DemoLogs. This location can be change from nLog.config file.

Once again, thank you so much for purchasing this script. As I said at the beginning, I'd be glad to help you if you have any questions relating to this script. I'll do my best to assist. If you have a more general question relating to the scripts on Codecanyon, you might consider visiting the forums and asking your question in the "Item Discussion" section.

Sangib Kumar Saha