About Fleet Tracker API

Setup

Use the following commands to setup the project:

chmod +x setup.sh
./setup.sh

Optionally you can follow the official Laravel installation guide.

By default, database use temporary filesystem (that wipes up data every reboot) to speed up the development. To use persistence database, you can must comment the following lines in the end of docker-compose.yml file:

driver_opts:
    o: bind
    type: none
    device: '/dev/shm'

Usage

Run the following command to start the development server and other services such as database, redis etc.:

sail up -d

To stop the development server and other services, run the following command:

sail down

or to stop the development server, run the following command:

sail stop

To start the frontend development server run the following command:

sail npm run dev

Please refer to official Laravel documentation for more information about Sail.

Documentation

Documentation is available on /docs.

API Documentation is available on /docs/api.

Generating documentation

Documentation is generated using phpDocumentor. To generate documentation, run the following command:

./generate_docs.sh

API Documentation is generated automatically thanks to Scramble.

License

Copyright (C) 2023 Damian Chojnacki

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a “Source” link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.