Bookmarks API

This is a bookmarks REST API built with Laravel. It allows you to perform various actions on bookmarks like creating a bookmark, marking a bookmark as favorite, archiving a bookmark, etc.

Installation

Requires PHP 8.1+

Using Laravel Sail

1. Clone this repository

   git clone https://github.com/sissokho/bookmarks-api.git

2. Install composer dependencies

   docker run --rm \
   -u "$(id -u):$(id -g)" \
   -v "$(pwd):/var/www/html" \
   -w /var/www/html \
   laravelsail/php81-composer:latest \
   composer install --ignore-platform-reqs

3. Copy .env.example to .env file

   cp .env.example .env

4. Set your DB_HOST environment variable within your .env file to mysql:

   DB_HOST=mysql

5. Start Sail

   ./vendor/bin/sail up
   
   # or you may start Sail in "detached" mode if you want to start all of the Docker containers in the background:
   ./vendor/bin/sail up -d

6. Generate app key

   ./vendor/bin/sail artisan key:generate

7. Run database migrations

   ./vendor/bin/sail artisan migrate

Using php artisan serve

1. Clone this repository

   git clone https://github.com/sissokho/bookmarks-api.git

2. Install composer dependencies

   composer install

3. Copy .env.example to .env file

   cp .env.example .env

4. Create a database

5. Setup a working email driver like Mailtrap. This tutorial shows how to set it up with Laravel.

6. Fill in the database and email environment variables in .env file

7. Generate app key

   php artisan key:generate

8. Run database migrations

   php artisan migrate

9. Run Server

   php artisan serve

Documentation

You can find the documentation of the API here.