juancarloscruzdela / rmms-backend Goto Github PK

Laravel CRUD API application for Digital Information Content Platform with Telecommunications Network-Assisted Remote Monitoring and Management project included with Authentication Module & Book, Video, & Device Module. It's included with JWT authentication and Swagger API format.

1. PHP-8
2. Laravel-9

1. Laravel 9.x
2. Interface-Repository Pattern
3. Model Based Eloquent Query
4. Swagger API Documentation - https://github.com/DarkaOnLine/L5-Swagger
5. JWT Auth - https://github.com/tymondesigns/jwt-auth
6. PHP Unit Testing - Some basic unit testing added.

sudo nano /var/www/rmms-backend/public/announcement.txt

after updating the txt file hit ctrl + x > enter Y > hit enter again to save.

sudo nano /var/www/rmms-backend/public/admin_password.txt

after updating the txt file hit ctrl + x > enter Y > hit enter again to save.

1. Register User API with Token
2. Login API with Token
3. Authenticated User Profile
4. Refresh Data
5. Logout

1. Book List
2. Book List [Public]
3. Create Book
4. Edit Book
5. View Book
6. Delete Book

1. Video List
2. Video List [Public]
3. Create Video
4. Edit Video
5. View Video
6. Delete Video

1. Device IP
2. Device List
3. Device List [Public]
4. Create Device
5. Edit Device
6. View Device
7. Delete Device

1. Clone Project -

git clone https://github.com/juancarloscruzdela/rmms-backend.git

1. Go to the project drectory by cd rmms-backend & Run the
2. Create .env file & Copy .env.example file to .env file
3. Create a database called - rmms.
4. Install composer packages - composer install.
5. Now migrate and seed database to complete whole project setup by running this-

Migrate tables

php artisan migrate:refresh

Migrate & seed tables

php artisan migrate:refresh --seed

It will create 21 Users and 103 Dummy Books.

6. Generate Swagger API

php artisan l5-swagger:generate

7. Initialize API routes & config.

php artisan optimize

8. Run the server -

php artisan serve

9. Open Browser - http://127.0.0.1:8000 & go to API Documentation - http://127.0.0.1:8000/api/documentation
10. You'll see a Swagger Panel.

1. First Login with the given credential or any other user credential
2. Set bearer token to Swagger Header or Post Header as Authentication
3. Hit Any API, You can also hit any API, before authorization header data set to see the effects.

1. Test with Postman - https://www.getpostman.com/collections/5642915d135f376b84af [Click to open with post man]
2. Test with Swagger.
3. Swagger Limitation: Image can not be uploaded throw Swagger, it can be uploaded throw Postman.