Skip to content

Commit 5c25f90

Browse files
committed
Added guide for installation
1 parent 48e6895 commit 5c25f90

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

readme.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
## Dotnet-Core-Attendance-System ##
2+
3+
Attendance Web application using .NET Core 2.1 Web Api & Vue.js
4+
5+
Use login: `admin` and password: `123456`
6+
7+
### Installation ###
8+
```
9+
git clone https://github.com/jioo/Dotnet-Core-Attendance-System.git
10+
11+
# Navigate to Web Api folder
12+
cd WebApi
13+
14+
# Restore NuGet packages
15+
dotnet restore
16+
17+
# Prepare user secret
18+
dotnet user-secrets set "AppSecret" "__YOU_SECRET_KEY__"
19+
20+
# Migrate database
21+
dotnet ef database update
22+
23+
# Start server w/ file watcher
24+
dotnet watch run
25+
26+
# Navigate to Web Client folder
27+
cd WebClient
28+
29+
# Install dependecies
30+
npm install
31+
32+
# Start client dev w/ hot module replacement
33+
npm run dev
34+
```
35+
36+
### Features ###
37+
38+
* Fully separate Backend and Frontend
39+
* Generic Repository Pattern
40+
* Material design
41+
* Authentication based on Identity Framework & JWT
42+
* Realtime update on employee logs
43+
44+
### Includes ###
45+
46+
* [.NET Core 2.1](https://docs.microsoft.com/en-us/dotnet/core/) open-source general-purpose development platform maintained by Microsoft.
47+
* [Entity Framework Core](https://www.nuget.org/packages/Microsoft.EntityFrameworkCore/) lightweight and extensible version of the popular Entity Framework data access technology.
48+
* [AspNetCore.Identity](https://www.nuget.org/packages/Microsoft.AspNetCore.Identity/) ASP.NET Core Identity is the membership system including membership, login, and user data.
49+
* [AutoMapper]() A convention-based object-object mapper.
50+
* [Microsoft.AspNetCore.SignalR](https://www.nuget.org/packages/Microsoft.AspNetCore.SignalR/) Components for providing real-time bi-directional communication across the Web.
51+
52+
* [Vue.js](https://vuejs.org/) The Progressive JavaScript Framework.
53+
* [Vuetify](https://vuetifyjs.com/en/) Material design component framework for Vue.js.
54+
* [Vuex](https://vuex.vuejs.org/en/intro.html) State management pattern + library for Vue.js.
55+
* [Vue-Router](https://router.vuejs.org/en/) Vue Router is the official router for Vue.js.
56+
* [Axios](https://github.com/axios/axios) Promise based HTTP client for the browser and node.js.
57+
* [@aspnet/signalr](https://github.com/aspnet/SignalR) JavaScript and TypeScript clients for SignalR for ASP.NET Core

0 commit comments

Comments
 (0)