https://github.com/fakorede/credpal-api
https://github.com/fakorede/credpal-api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fakorede/credpal-api
- Owner: Fakorede
- Created: 2020-07-14T13:26:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T11:33:58.000Z (over 2 years ago)
- Last Synced: 2025-04-22T23:16:48.314Z (about 2 months ago)
- Language: PHP
- Size: 3.05 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CredPal Assessment
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
## Pre-requisites
What things you need to install the software.
- Git
- PHP
- Composer
- Web Server like Nginx or Apache
- Npm or Yarn
## Installation
Clone the git repository on your computer
```
$ git clone https://github.com/Fakorede/credpal-api.git
```
You can also download the entire repository as a zip file and unpack in on your computer if you do not have git
After cloning the application, you need to install it's dependencies.
```
$ cd credpal-api
$ composer install
$ npm install && npm run dev
```
## Setup
When you are done with installation, copy the .env.example file to .env
```
$ cp .env.example .env
```
Generate the application key
```
$ php artisan key:generate
```
Create database and add its configuration
```
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=your_db_name
DB_USERNAME=your_db_username
DB_PASSWORD=your_db_password
```
Passport setup
Create keys:
```
php artisan passport:install
```
Add keys to .env
```
PASSPORT_GRANT_TYPE=password
PASSPORT_CLIENT_ID=2
PASSPORT_CLIENT_SECRET=
```
Run database migrations
```
$ php artisan migrate
```
Seed database with dummy data
```
$ php artisan db:seed
```
Run tests
```
$ ./vendor/bin/phpunit
```
Run the app
```
$ php artisan serve
```
## Built With
- Laravel - The PHP framework for building the API endpoints needed for the application
- Vue - The Progressive JavaScript Framework for building interactive interfaces