|
1 | 1 | <h1 align="center">Attendance System using Face Recognition</h1> |
2 | 2 | <p> |
3 | 3 | <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" /> |
4 | | - <a href="https://github.com/codeglitchz/attendance-system#readme" target="_blank"> |
5 | | - <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" /> |
6 | | - </a> |
7 | | - <a href="https://github.com/codeglitchz/attendance-system/graphs/commit-activity" target="_blank"> |
8 | | - <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /> |
9 | | - </a> |
10 | 4 | <a href="https://github.com/codeglitchz/attendance-system/blob/master/LICENSE" target="_blank"> |
11 | 5 | <img alt="License: MIT" src="https://img.shields.io/github/license/codeglitchz/attendance-system" /> |
12 | 6 | </a> |
|
15 | 9 | > A simple, modern and scalable facial recognition based attendance system |
16 | 10 | > built with Python back-end & Angular front-end |
17 | 11 |
|
18 | | -### 🏠 [Homepage](https://github.com/codeglitchz/attendance-system#readme) |
| 12 | +#### [UI](https://github.com/codeglitchz/attendance-system/blob/master/sample/ui.gif) |
19 | 13 |
|
20 | 14 | ## Table of contents |
21 | 15 | * [Prerequisites](#prerequisites) |
22 | 16 | * [Installation](#installation) |
23 | | - 1. [Clone repository](#clone-repository) |
24 | | - 2. [Setup backend](#setup-backend) |
25 | | - 3. [Setup frontend](#setup-frontend) |
26 | | -* [Usage](#usage) |
27 | | - 1. [Using CLI](#using-cli) |
28 | | - 2. [Using Web Interface](#using-web-interface) |
| 17 | + 1. [Clone repository](#1-clone-repository) |
| 18 | + 2. [Setup backend](#2-setup-backend) |
| 19 | + 3. [Setup frontend](#3-setup-frontend) |
| 20 | +* [Usage](#usage)\ |
| 21 | + a. [Using CLI](#a-using-cli)\ |
| 22 | + b. [Using Web Interface](#b-using-web-interface) |
29 | 23 |
|
30 | 24 | ## Prerequisites |
31 | 25 |
|
32 | 26 | * Python v3.7+ |
33 | 27 | * Miniconda3 (optional) (recommended) |
| 28 | +* CMake |
| 29 | +* Visual Studio Build Tools |
| 30 | +* Nvidia CUDA (optional - for nvidia gpus) |
34 | 31 | * Node.js LTS v12.8.0+ (npm v6.14.4+) |
35 | 32 | * Angular CLI v9.1.8+ |
36 | 33 | * Windows or Linux (macOS not officially supported, but might work) |
37 | 34 |
|
38 | 35 | ## Installation |
39 | 36 |
|
40 | 37 | #### 1. Clone repository |
| 38 | +For stable release, clone `master` branch |
41 | 39 | ```sh |
42 | | -$ git clone https://github.com/codeglitchz/attendance-system |
| 40 | +$ git clone -b master https://github.com/codeglitchz/attendance-system.git |
43 | 41 | $ cd attendance-system |
44 | 42 | ``` |
45 | 43 | #### 2. Setup backend |
@@ -96,13 +94,9 @@ $ ng serve -o |
96 | 94 |
|
97 | 95 | ## Authors |
98 | 96 |
|
99 | | -👤 **CodeGlitchz** |
100 | | - |
101 | | -* Github: [@codeglitchz](https://github.com/codeglitchz) |
102 | | - |
103 | | -👤 **CodeWhizz** |
| 97 | +👤 [**@codeglitchz**](https://github.com/codeglitchz) |
104 | 98 |
|
105 | | -* Github: [@codewhizz](https://github.com/codewhizz) |
| 99 | +👤 [**@codewhizz**](https://github.com/codewhizz) |
106 | 100 |
|
107 | 101 | ## 🤝 Contributing |
108 | 102 |
|
|
0 commit comments