Laravel application developed for a developer test.

This repo is functionality complete — PRs and issues welcome!

Getting started

Installation

Please check the official laravel installation guide for server requirements before you start. Official Documentation

Alternative installation is possible without local dependencies relying on Docker.

Clone the repository

git clone https://github.com/danielrdesousa/school-manager

Switch to the repo folder

cd api

Install all the dependencies using composer

composer install

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Generate a new application key

php artisan key:generate

Run the database migrations (Set the database connection in .env before migrating)

php artisan migrate

Run the laravel passport key

php artisan passport:install

Run the database seeder and you're done

php artisan db:seed

Start the local development server

php artisan serve

You can now access the server at http://localhost:8000

Commands list

git clone https://github.com/danielrdesousa/school-manager
cd api
composer install
cp .env.example .env
php artisan key:generate
php artisan migrate
php artisan passport:install
php artisan db:seed
php artisan serve

Make sure you set the correct database connection information before running the migrations Environment variables

php artisan migrate
php artisan serve

Database seeding

Populate the database with seed data with relationships which includes users, articles, comments, tags, favorites and follows. This can help you to quickly start testing the api or couple a frontend and start using it with ready content.

Run the database seeder and you're done

php artisan db:seed

Note¹ : It's recommended to have a clean database before seeding. You can refresh your migrations at any point to clean the database by running the following command

php artisan migrate:refresh

Note² : Run the passport install after migrate:refresh

php artisan passport:install

Docker

To install with Docker, run following commands:

    not yet implemented

The api can be accessed at http://localhost:8000/api.

API Specification

    not yet implemented

Code overview

Dependencies

Laravel Passport - For authentication using JSON Web Tokens
Eloquent Builder - Build eloquent queries based on request parameters

Folders

app/Http/Controllers/Api - Contains all the api controllers
app/EloquentFilters - Contains all the filters params
config - Contains all the application configuration files
database/factories - Contains the model factory for all the models
database/migrations - Contains all the database migrations
database/seeds - Contains the database seeder
routes - Contains all the api routes defined in api.php file
tests - Contains all the application tests

Environment variables

.env - Environment variables can be set in this file

Note : You can quickly set the database information and other variables in this file and have the application fully working.

Testing API

Run the laravel development server

php artisan serve

The api can now be accessed at

http://localhost:8000/api

Request headers

Required	Key	Value
Yes	Content-Type	application/json
Yes	X-Requested-With	XMLHttpRequest
Optional	Authorization	Token

Refer the api specification for more info.

Note : If you use "insomnia" import json file to make testing easier. insomnia_school_manager.json

Authentication

This applications uses Laravel Passport to handle authentication. The token is passed with each request using the Authorization header with Token scheme.Please check the following sources to learn more about Laravel Passport.