- PHP8
- Database - MariaDB 10.3 was used
- Webserver - Tested at Nginx 1.18 only
- Composer
- Clone the repository
- Run
composer installto download all the dependencies. Currently, the project depends on just two packages. First for environment management and second one for request data validation. - Create database for the project.
- Use
schema.sqlto populate all the necessary tables. - Copy
.env.exampleto.envat the root of the project. - Fill required credentials for the database connection at the
.envfile. - Setup virtual host for the project (note that document root should point to
publicdirectory). Nginx example configuration as follows:
server {
listen 80;
listen [::]:80;
root /path-to-project-directory/public;
index index.php;
access_log off;
error_log /path-to-project-directory/error.log;
server_name sms-otp.test;
location / {
try_files $uri $uri/ /index.php?$query_string;
}
# pass PHP scripts to FastCGI server
location ~ \.php$ {
include snippets/fastcgi-php.conf;
fastcgi_pass unix:/var/run/php/php8.0-fpm.sock;
}
# deny access to .htaccess files, if Apache's document root
# concurs with nginx's one
location ~ /\.ht {
deny all;
}
}
- Modify your host file to be able to use the test domain.
127.0.0.1 sms-otp.test
/route will show a welcome page./registerwill show the user registration form.- After successful registration, you will be redirected to phone verification page (
/verify). - While at
/verify, wait 1 minute and refresh to view the extra button for sending new phone verification. - Submit verification form up to 3 time to get verification cool down message. Wait 1 minute to be able to use this feature again.
- After successful verification you will be redirected to
/dashboardwhich is just a page that shown that all went OK.
/public- The document root/public/index.php- Application boostrap, route setup, etc./src/Controllers- Controllers directory. Controllers were made as a single action controller just to keep the as clean as possible./src/Core- Application core modules like session, database, etc./src/Exceptions- Application exceptions/src/Models- Model files./src/Repositories- Where the actual database queries are executed./src/Services- Service classes like Notification service, phone sanitizer and validator service, etc./src/Support- Helper classes and files./src/View- HTML templates.