Website application that makes managing & administrating your virtual QR Code keys easier.
Created in Laravel + Vue.js
⭐ Star us on GitHub — it motivates us a lot!
About • Requirements • Installation • Testing • Contributing • License
Landing Page
- Registration with e-mail verification
- Sending e-mail invitations to the team
- Option to reset password via e-mail
Registration Page
- Creating and Configuring Teams
- Assigning Gates to Team
- Adding Virtual Keys to open Gates
Dashboard
- Update Profile Informations
- Add Avatar
- Update Password
- Enable Two Factor Authentication
- If you would like to run the project via Docker Desktop, follow these steps:
- Copy
.env.example
to.env
- Create Docker Containers
docker-compose up -d
- Open Container
docker-compose exec php bash
- Install composer dependencies
composer install
- Run DB migrations (needed only once or on migration addition)
php artisan migrate
- Link storage (needed only once)
php artisan storage:link
- Install NPM dependencies (needed only once or on package changes)
npm install
- Run the NPM dev build with --host option
npm run dev -- --host
- Fix for possible errors after logging into account:
chown -R www-data:www-data /var/www/html/storage /var/www/html/bootstrap/cache
- If you would like to run the project via Docker Sail, follow these steps:
- Copy
.env.example
to.env
- Install composer dependencies (in order to pull the Laravel Sail bash files, needed only once)
docker run -it -v "$PWD:/app" composer composer install --ignore-platform-reqs
- Run the project
./vendor/bin/sail up -d
- Run DB migrations (needed only once or on migration addition)
./vendor/bin/sail artisan migrate
- Link storage (needed only once)
./vendor/bin/sail artisan storage:link
- Install NPM dependencies (needed only once or on package changes)
./vendor/bin/sail npm install
- Run the NPM dev build
./vendor/bin/sail npm run dev
Package | Version |
---|---|
Node | V14.19.1+ |
Npm | V6.14.16+ |
Composer | V2.2.6+ |
Php | V8.0.2+ |
Mysql | V 8.0.27+ |
Warning Make sure to follow the requirements first. Here is how you can run the project locally:
-
Clone this repo
git clone https://github.com/theiotproject/key-manager.git
-
Go into the project root directory
cd key-manager
-
Create database
key_manager
(you can change database name) -
Install PHP dependencies
composer install
-
install front-end dependencies
npm install && npm run dev
-
Copy .env.example file to .env file
cp .env.example .env
-
Configure .env with your data
-
Configure mailhog <- Check here how
-
Run migration
php artisan migrate
-
Run server
php artisan serve
-
Visit
localhost:8000
in your favorite browser.Make sure to follow your Laravel local Development Environment.
You can check out API documentation here
php artisan test
- Fork it ( https://github.com/theiotproject/key-manager/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
key-manager is under MIT Licence