Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 1.77 KB

README.md

File metadata and controls

77 lines (51 loc) · 1.77 KB
Raw

myshortener

MyShortener is an API to make an URL shortener.

Requirements

  • Laravel
  • MySQL

Version

1.0.0

Tech

  • Laravel - The PHP Framework For Web Artisans
  • Composer - Dependency Manager for PHP

Installation

Download zip file and extract it latest pre-built release. Or clone the repository and cd into it.

Install the dependencies and start the server.

cd myshortener
composer install
cp .env.example .env

If you don't have .env file you can use the example one. Just rename .env.example to .env. Enter your configuration here (Database and App Url Configurations). Set the application key

php artisan key:generate

Migrations

Run the following command to run startup migrations.

php artisan migrate

Run

Run the following command to start the HTTP Server.

php artisan serve

APIDocs

To generate the APIDocs first you have to install apidoc globally

npm install apidoc -g

After that you can generate the APIDocs running the following commands

cd myshortener
apidoc -i ./app/Helpers/ -o ./public/apidocs

After this you should be able to see the API Documentation in your browser hitting http://localhost/yourprojectname/public/apidocs

APIDocs file APIDocs.

Todos

  • Write tests
  • Add code comments