https://github.com/murage-poc/palmina

https://github.com/murage-poc/palmina

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/murage-poc/palmina
• Owner: murage-poc
• Created: 2021-09-21T16:22:36.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-09-21T23:55:11.000Z (over 3 years ago)
• Last Synced: 2023-12-17T19:27:24.567Z (about 1 year ago)
• Language: PHP
• Homepage:
• Size: 686 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Palmina

Laravel based technical test

## Available API Routes

|Endpoint|Description|Sample

|---|---|---|

|/api/v1/auth/login  | User login with user/password. Returns a token (sanctum) | |

|/ api/v1/auth/register | Register a user account  |  

|/api/v1/users/me | Get user account. Expects a bearer token |

Sample body `/api/v1/auth/register`

```json

{

    "name":"Jane Doe",

    "password":"password@1234",

    "password_confirmation":"password@1234",

    "email":"[email protected]",

    "phone_number":"254712345678"

}

```

Sample body `/api/v1/auth/login`

```json

{

    "password":"password@1234",

    "email":"[email protected]"

}

```

## Local setup

### Prerequisite

- PHP 7.4+

- Mysql database

- Composer

1. Install project php dependencies with composer ``composer install``

2. Create a database and update the credentials in .env file

3. Run migrations ``php artisan migrate``

4. Seed the database table with some users ``php artisan db:seed``

### Using sail

1. Publish docker-compose

```shell

php artisan sail:install

```

2. Start the application

```shell

./vendor/bin/sail up

```