SmartFollow - API

This software is distributed under the Creative Commons Attribution - Non Commercial - No Derivatives 4.0 International license

Git workflow

1. Do not push on master
2. "main" branch is dev
3. Create a new feature branch for each new feature development
4. Do not merge feature branches with dev, create a pull request from feature branch to dev

Installation

Cloning the repository

git clone [email protected]:smartfollow/api.git
cd api

Configuring and installing Laravel setup

composer install
cp .env.example .env
php artisan key:generate
nano .env

Update the database informations and other relevant credentials.

php artisan migrate
php artisan db:seed
php artisan passport:install

Documentation

The documentation for the routes is available at http://path.to.smartfollow.api/docs

To generate it you have to install apiDoc and run the following command:

apidoc -i app/ -o public/docs/

Update after a pull

In order to make sure that the installation is up to date after the pull, it is required to execute the following commands:

composer dumpauto
php artisan config:cache
php artisan migrate
php artisan db:seed --class=UpdateAccessRulesSeeder
php artisan db:seed --class=UpdateAccessRuleGroupSeeder