AllMaps - The API Version
AllMaps is an open-source indoor map solution.
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
About The Project
AllMaps is an open-source indoor map solution.
Built With
AllMaps is built on top of these fantastic pieces of software.
Getting Started
This is a pretty default Laravel application, so if you know Laravel, then it should be streight forward to get started.
Prerequisites
You need to have Composer, A Dependency Manager for PHP, installed. Go get it Getting Started with Composer.
Installation
- Clone the repo
git clone https://github.com/nosuchagency/allmaps-api.git
- Install Composer packages
composer install
- Do the migration
php artisan migrate --seed
- Generate unique keys for your installation
php artisan key:generate
- Link the storage
php artisan storage:link
There is now seeded an administration user with email, [email protected], and code, password12.
Usage
AllMaps API is just that - an API. So you need to create an app to interact with AllMaps. But if you want to manage the content in AllMaps, then install AllMaps CMS.
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Peter Kær - @peterkaer - [email protected]
Project Link: https://github.com/nosuchagency/allmaps-api