gurpreetatwal/skeleton-api

This package is abandoned and no longer maintained. No replacement package was suggested.

A Slim Framework skeleton for a (almost) REST api that uses JWTs for authentication and Laravel's Eloquent as the ORM

dev-master 2016-03-31 10:32 UTC

Requires

• php: >=5.5.0
• egulias/email-validator: ^1.2
• filp/whoops: ^2.0
• illuminate/database: ^5.2.0
• monolog/monolog: ^1.17
• palanik/corsslim: dev-slim3
• phpunit/phpunit: ^5.1
• respect/validation: ^1.0
• slim/slim: ~3.0
• tuupola/slim-jwt-auth: ^2.0

MIT

• Gurpreet Atwal

• microframework
• rest
• router
• slim
• eloquent
• jwt
• psr7
• slim3

README

This project is still under development and is not ready for use in production.

This project helps to cut down on development time for PHP based APIs. Just by cloning the project you can create, update, find and delete users. The application supports JWT-based authentication, CORS for cross-site requests, and resource based urls. Logging is also set up already and application logs will be stored in logs/ directory.

Installation

It is assumed that composer is installed and available globally, if you need to install composer follow the steps here

Run this command from the directory in which you want to develop your new API.

composer create-project gurpreetatwal/skeleton-api [my-app-name] -s dev

Replace [my-app-name] with the desired directory name for your new API. You'll want to:

• Point your virtual host document root to your new application's public/ directory.
• Ensure logs/ is web writable.
• Create your environment.ini by copying the example and replacing the default values.

To run your API locally, you can use PHP's built-in sever by running the following command:

 php -S localhost:8888 -t public/ public/index.php

That's it! Now go build something cool.

Originally a fork of Slim-Skeleton