Skip to content

jefrydco/aio-rek

Repository files navigation

AIO Rek

Face recognition based attendance system

aio-rek

Features

This starter project includes official Nuxt.js modules for best PWA project:

It is also enriched with the best Vue's UI framework:

Prerequisite

You must have installed:

Setup

  1. Clone this repository
$ git clone https://github.com/jefrydco/aio-rek.git
$ cd aio-rek
  1. Download the following repository Face API
  2. Extract its content
  3. There will be a folder called weights. Copy that folder into aio-rek/static
  4. Rename it in to models
  5. Now the content of your static folder should looks like this:
static
|-cats
|-models
|-sounds
|-examples
  1. Then run the following command to run the project
# instal dependencies
$ yarn # or npm install

# run the docker environment
$ docker-compose up

# serve the api at localhost:3001
$ yarn api

# serve with hot reload at localhost:3000
$ yarn dev

Test

# run unit test
$ yarn test

# run e2e test
$ yarn test:e2e:open

Getting Started

Don't forget to change your sentry dsn and google analytics id in .env.example file.

For detailed explanation on how things work, check out the Nuxt.js and Vuetify.js documentation.

License

MIT License

Copyright (c) Jefry Dewangga (@jefrydco)