Skip to content
This repository has been archived by the owner on Feb 17, 2024. It is now read-only.
/ minim-demo Public archive

A demonstration of the Minim single-user authentication library.

License

Notifications You must be signed in to change notification settings

semibreve/minim-demo

Repository files navigation

Minim Demo Application

A demonstration of the Minim single-user authentication library.

Screenshot

Prerequisites

You'll need to have a web server installed and configured with PHP for this to work. I really recommend XAMPP, especially for Windows users. Once you've done that you can proceed.

You'll also need Node.js and npm installed and working.

Building

Clone the project down and open the folder in your favourite editor. It's a JetBrains PhpStorm project but you can use whichever paid/free software takes your fancy.

Before anything else, note that this project uses the Composer package manager. Install composer (see their website) and run:

composer install

Or alternatively, if you're using the PHAR (make sure the php.exe executable is in your PATH):

php composer.phar install

Then, install the npm packages necessary to build and run the website. Run the following in your terminal in the project root directory:

npm install

This will install Bower which will allow you to install the assets the website requires (Bootstrap, jQuery etc.) using the command:

bower install

Gulp will also have been installed. This will compile the Less into CSS ready for production. Do this using the command:

gulp

This command will need running again every time you make a change to a Less file. If you're working on them, run gulp watch in a terminal to watch for file changes and compile accordingly.

Configuration

This demo application comes with a set of default credentials.

Email: me@example.com
Password: demo

These must be changed before you go into production. Set everything up according to the configuration guide for Minim.

Limitations

Don't rely on Minim to be secure out of the box and always perform your own penetration testing.