mapmarker / mapmarker.io

A straight-forward API that generates complex map markers on the fly.

mapmarker.io

Generate complex map markers on the fly.

MapMarker.io is a straight-forward API that generates complex map markers on the fly. Developers can effortlessly create interactive applications centered around maps.

Development

Requirements

Requirement	Version
PHP	^8.0.2
Node	14

Installing Dependencies

composer install
nvm use
yarn
cp ./.env.example ./.env
php artisan key:generate

Development Environment

Launch the docker-based dev environment using the following command

yarn sail up -d

Compiling Assets

To automatically compile assets while developing, simply run the watch command. This will ensure that css is re-compiled automatically when you make changes to the templates or components of this project.

yarn watch

Code Formatting

This project uses laravel/pint to handle code format checking and fixing.

Helper: Pint

yarn pint

Helper: check code for formatting issues

yarn style

Helper: fix code formatting issue

yarn style:fix

Commit Integration

Thee package.json has a command helper for committing changes. As part of that helper command, code style is automatically fixed and all changes are added to the scope of the commit.

"commit": "yarn style:fix && git add . && ./node_modules/commitizen/bin/git-cz",

Committing Changes

This project uses commitizen to keep commits organized and to automate version tagging. To commit changes you made, run the following commands and follow the prompots:

git add .
yarn commit