Assess Hour

A Solution for online assessment (SaaS)

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.

Overview

Assess Hour is a single page(SPA) web application / platform for online Assessments, tests, surveys, quizzes and exams. It's best suited for the online evaluations and skills assessment for the educational institutions, companies, corporations and agencies. You can start your own SaaS businees with Assess Hour, also your customers can earn money by selling their own assessments.

 

Project Requirement

Quick Start Guide

AssessHour project has two separate project i.e. AssessHourClient and AssessHourApi.

                        -> dotnet ef migrations add initial
                        -> dotnet ef database update
                        -> dotnet run
                You should see your API listening at localhost:5003.

                        -> npm install
                        -> npm run serve

                Your project will be running at localhost:8080. 

 

N.B: This is just a quick start note, you need to follow full documentation for full project set up which starts from below.

 

Set up AssessHourApi

"ConnectionStrings": {

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

    "ApiConnStringMysql": "server=localhost;port=3306;database=assesshourdb;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=assesshourdb.db;",

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

  }

 

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"))); */

 

               ->dotnet tool install --global dotnet-ef

               ->dotnet ef migrations add MigrationName

               ->dotnet ef database update

Set up AssessHourClient

Run on Local Machine

Assuming that you run both api and client projects by following previous steps. Now you just need to open config.js (/assesshourclient/src/config.js) from Client project and set hostname as http://localhost:5003 because our api is running here and you need to link with api from client.

export default{
    hostname:'http://localhost:5003'
}

 

Server Requirements

For Windows Server with IIS

 

For Linux Server with Nginx

Here is some resourses so that you can find more detail about above installations-

 

Publish to Server

Windows Server

  services.AddCors(options=>
   {
     options.AddPolicy(name:AllowSpecificOrigins,builder=>
       {
         builder.WithOrigins("http://localhost:8080","https://assesshour.com")
         .AllowAnyHeader()
         .AllowAnyMethod();
       });
   });

 now on vscode terminal write below command

                 -> dotnet publish

you will get a publish(/assesshourapi/bin/Debug/net6.0/publish) directory. Now copy the Resources folder from root directory(/quizplusapi/Resources) and replace that with Resources folder on publish directory. Now Copy the publish directory to a physical path on server. Now open a new site on IIS with Site name, Physical path, IP address, Port and Host name. Now assuming that you set the Host name as api.assesshour.com, copy that name and store somewhere because we need that name just a bit later.

export default{
    hostname:'https://api.assesshour.com'
}

 now on vscode terminal write below command

                  ->npm run build

 you will get a dist(/assesshourclient/dist) directory. Now find a web.config (/assesshourclient/web.config) file on root directory of client project, Copy that file and paste it to inside dist directory. Everything is ready.

Now you need to copy this dist directory to a physical path on server and open another site with Host name as assesshour.com. That's all for windows server.

 

Linux(Ubuntu) Server

  services.AddCors(options=>
   {
     options.AddPolicy(name:AllowSpecificOrigins,builder=>
       {
         builder.WithOrigins("http://localhost:8080","https://assesshour.com")
         .AllowAnyHeader()
         .AllowAnyMethod();
       });
   });

 now on vscode terminal write below command

                 -> dotnet publish

you will get a publish(/assesshourapi/bin/Debug/net6.0/publish) directory. Now copy the Resources folder from root directory(/quizplusapi/Resources) and replace that with Resources folder on publish directory. Now you will need to create a directory named AssessHour.Api on your Linux server. Execute below command on your linux terminal to create that directory then copy the publish directory to this (/var/www/AssessHour.Api) path.

                 -> sudo mkdir /var/www/AssessHour.Api

Now it's time to configure nginx, open a config file,

                -> sudo nano /etc/nginx/sites-enabled/assessHourApi

Place the below contents and save that file.

server {

    listen        80;
    server_name  api.assesshour.com;
    location / {
        proxy_pass         http://localhost:5003;
        proxy_http_version 1.1;
        proxy_set_header   Upgrade $http_upgrade;
        proxy_set_header   Connection keep-alive;
        proxy_set_header   Host $host;
        proxy_cache_bypass $http_upgrade;
        proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header   X-Forwarded-Proto $scheme;
  }
}
 
Let's create a service now to run your Api,
 
               -> sudo nano /etc/systemd/system/AssessHour.Api.service
 
Place below contents and save that service
 
          [Unit]
          Description=Api for AssessHour client App

          [Service]
          WorkingDirectory=/var/www/AssessHour.Api/publish
          ExecStart=/usr/bin/dotnet /var/www/AssessHour.Api/publish/QuizplusApi.dll
          Restart=always
          # Restart service after 10 seconds if the dotnet service crashes:
          RestartSec=10
          KillSignal=SIGINT
          SyslogIdentifier=AssessHour.Api
          User=ubuntu-user
          Environment=ASPNETCORE_ENVIRONMENT=Production
          Environment=DOTNET_PRINT_TELEMETRY_MESSAGE=false
          Environment=ASPNETCORE_URLS=http://localhost:5003

          [Install]
          WantedBy=multi-user.target
 
 
Notice, the User is set to 'ubuntu-user' , Chnaged that by your linux user which has full permission on the app directory.
 

  • Now, Open Client project on VS Code and set that 'https://api.assesshour.com' on hostname to config.js file.

export default{
    hostname:'https://api.assesshour.com'
}

 now on vscode terminal write below command

                  ->npm run build

 you will get a dist(/assesshourclient/dist) directory. 

Now you will need to create a directory named AssessHour.Client on your Linux server. Execute below command on your linux terminal to create that directory then copy the dist directory to this (/var/www/AssessHour.Client) path.

                 -> sudo mkdir /var/www/AssessHour.Client

Next, open a config file,

                -> sudo nano /etc/nginx/sites-enabled/assessHourClient

Place the below contents and save that file.

server {
    listen      80;
    server_name assesshour.com;
    charset utf-8;
    root    /var/www/AssessHour.Client/dist;
    index   index.html;
    #Always serve index.html for any request
    location / {
        root /var/www/AssessHour.Client/dist;
        try_files $uri  /index.html;
    }
    error_log  /var/log/nginx/vue-app-error.log;
    access_log /var/log/nginx/vue-app-access.log;
}
 
 
Now let's end by executing below commands on linux terminal
              -> sudo systemctl enable AssessHour.Api
              -> sudo service mysql restart
              -> sudo service nginx restart 
 
That's all for linux server.

Credentials

For Super Admin, Username:superAdmin@assessHour.com  Password:abcd1234

Payment Testing

To find more detail you can browse this link (https://stripe.com/docs/testing)

Features(Super Admin)

Super Admin user has below menus

we will discuss briefly each of the menus.

 

 

Dashboard

 In Super Admin Dashboard, application status will show by different charts & data. Charts are based on different data like

 

 

Menus

 Here you find a list of all menus of this App. To add a new menu you have to fill below fields

 

Roles

You will find three roles (Super Admin,Admin & Student) here. These roles are restricted to modify and delete because these are used for many configuration issues.

Anyway you can assign menus for a role from actions.

 

 

Users

You will find all admin users here with there transaction detail, plan, plan interval, payment mode & others. Also you can manage offline transactions from here. You can add new users from here with transaction details.

 

 

FAQ

All faqs are here. You can add new faq from here also can modify exting faqs. Those faqs will viewed by other roles users.

 

 

Contacts

All requests and queries which input come from landing page will be viewed here.

 

 

Payments

All transactions of admins are here. You can see all possible data which are generated by customers when they purchase any of your subscription plan.

 

Plans

You can see all subscription plans from here, can modify, delete & add new one from here by filling below fields

 

App Settings

 Total app settings including site logo, site favicon, site title, welcome message, copyright text, allow welcome email, allow FAQ, Exam Settings, Payment Settings, Email Settings & Color controls.

  1.     General Settings ( site logo, site favicon, site title, welcome message, copyright text, allow welcome      email, allow  FAQ, App version etc.)
  2.     Exam Settings ( Browser refresh end the exam , site logo on exam page)
  3.     Payment Settings ( you need to put your Stripe secret key here to take online payments)
  4.     Email Settings  

               ->For Gmail Port: 587 , Host: smtp.gmail.com

               ->For Yahoo Port: 587 , Host: smtp.mail.yahoo.com

               ->For Outlook Port: 587 , Host: smtp-mail.outlook.com

         5.   Color Settings ( Color controls for Menu Bar , Header, Footer & Body)

 

Keep in mind, if you change app version number then a pop up (like below image) will appear on dashboad which will instruct you to refresh. Change the app version only when you do some code label change on Client project.

Features(Admin)

Admin user has below menus

we will go through all of those.

 

 

Dashboard

 In Admin Dashboard, below charts are available

Also in dashboard you will see a message dialog box(see below image) if your existing subscription plan is expired and you can renew your plan by using that.

 

Users

As an admin you can add and manage your candidates from here.

 

Category

All your question category will apear here and you can add & manage new categories from here.

 

Assessments

 It is the starting point of a new Assessment. You can create a new Assessment by filling below fields,

 

Questions

 List of assessments in box shape with some other fields will be viewed here and you can add question by filling below fields

  1.     Question ( No duplicate is accepted for a particular quiz)
  2.     Code Snippet ( Check this only if you want set pre-formatted questions like Programming language code or anything you want keep source format)
  3.     Question Type ( MCQ & Descriptive)
  4.     Complexity Lavel (Easy, Medium & Hard)
  5.     Question Category(select one category from your existing category list)
  6.     Question Video (Only youtube embed video is allowed) (Optional)
  7.     Question Image (Optional)
  8.     Option-A
  9.     Option-B
  10.     Option-C (Optional)
  11.     Option-D (Optional)
  12.     Option-E (Optional)
  13.     Correct Answer
  14.     Answer Explanation (Optional)

(8-13) applicable for MCQ questions only.

 

Certificate Templates

 Design templates from here and allow those to recognize your candidates

 Avaiable fields

There is a list (Student Name, Mobile, Address, Title etc.) on top of all fields. You can drag them and drop on any of the text fields as per your need. 

 

Examine & Reports

All your candidates exam records will find here and examine options will visible for descriptive questions assessments. You can filter those and can download those on PDF,CSV & Excel. Also here you find a Sent Email button, use that if you want to sent email to your selected candidates.

 

Payments

Here you can see all payments data of your paid assessments. Also you need to set your Stripe  secret key to accept payments for paid assessment by clicking Payment Settings button on top right corner.

 

Features(Candidates)

Dashboard

On candidate dashboard, you can see all your available assessments and can start by clicking the start button.

 

Reports

Here as a candidate you will find your all attempted assessments results in detail.

 

Analytics

Some data analysis here based on your login, exam attempt, data usage and others.

Conclusion

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 this script you may also comment directly on product comment section.

Sangib Kumar Saha