About

This is a simple api that enables users to register, login and view their profile details. An admin is also able to login into their dashboard and view the list of registered users and their particular details

Prerequisites

Download and install Composer
Download and install Postman for API Testing

Installation

Follow through the following steps setting up the application on your local development environment

git clone https://github.com/odera-dickens/pesakit.git <your_preffered_app_name>
cd <your_preffered_app_name>
composer install

Database Setup

cp .env.example .env
Create a database at your local db server then at the created .env file, add the following 
DB_DATABASE=<your_new_db>

Database Configurations

php artisan:key generate
php artisan migrate
php artisan db:seed (to create an admin user)

npm Set Up

npm install
npm run dev

API Authentication Support

This project uses Laravel Passport for the API Authentication

Passport Accest Tokens

To create client access tokens for accessing the api endpoints when testing, run the following command

php artisan passport:install

API Endpoints

User Registration

METHOD: POST
Endpoint: /api/v1/user/register
Params: 
1. name (required)
2. email (required)
3. phone (required)
4. password (required)
5. password_confirmation (required)

User Login

METHOD : POST
Endpoint: /api/v1/user/login
Params:  
1. email (required)
2. password (required)

User Logout

METHOD : POST
Endpoint: /api/v1/user/logout
Params:  
1. Bearer-Token

User Profile Details

METHOD : GET
Endpoint: /api/v1/user/profile
Params:  
1. Bearer-Token

Web Endpoints

Admin

Sample Admin Account : { email: [email protected], password: password }
/login
/admin/dashboard
/admin/users
/admin/users/{user}/profile

User

/login
/user/dashboard

Testing The API

In order to effectively test the api, ensure you have Postman installed on your machine

php artisan test (to run all the tests)
php artisan test --filter=<test_name> (check tests/Feature/Api/UserAuthenticationTest)

odera-dickens / pesakit Goto Github PK

pesakit's Introduction