Territory Services API is a RESTful api developed to provide easy and accessible storage and management for congregation territories. Although many systems can connect to the api via mobile and web client, the api does contain a client interface. Based on Laravel 5 and uses JWT-Token.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app Fix issue with User creation falsely retrieving duplicate Jul 21, 2018
bootstrap installed JWTAuth Dec 25, 2015
config Add Universal MAIL_TO Mar 11, 2017
database Make Publisher userId nullable - fix issue with missing publisher Feb 18, 2017
public Language change for S-13 form Nov 26, 2017
resources Language change for S-13 form Nov 26, 2017
storage Cleaned up files and update code for application Sep 21, 2016
tests first commit with laravel installation Dec 25, 2015
.env.example
.gitattributes first commit with laravel installation Dec 25, 2015
.gitignore
.htaccess Added JWT integration and Angular signup/Signin Dec 26, 2015
Procfile Added heroic deployment deps Feb 11, 2017
artisan first commit with laravel installation Dec 25, 2015
composer.json Prepare for Laravel 5.5 and PHP 7.2 Apr 5, 2018
composer.lock Prepare for Laravel 5.5 and PHP 7.2 Apr 5, 2018
gulpfile.js first commit with laravel installation Dec 25, 2015
package.json first commit with laravel installation Dec 25, 2015
phpunit.xml first commit with laravel installation Dec 25, 2015
readme.md Correct readme instructions for setting .env file Jul 21, 2018
server.php first commit with laravel installation Dec 25, 2015

readme.md

Territory Services API

Territory Services API is a RESTful api developed to provide easy and accessible storage and management for congregation territories. Although many systems can connect to the api via mobile and web client, the api does contain a client interface.

Core Services

  • Authentication
  • User Registration
  • User Roles and Privileges
  • Data Storage and CRUD

Core Entities

  • publishers: name, type (pioneer, regular) Crud

  • territory records: territory, publisher, activity type, date Crud

  • territories: number, location, boundaries (4 points) Relationships with publisher Crud

  • addresses: name, address, status Relationships with territories Crud

  • notes: content, user, type Relationships with addresses, territories, and publishers Crud

Additional Services

  • pdf Generate PDF

  • map Address coordinates Map image

Installation

  • Step 1 - Clone this repository into you dev directory
  • Step 2 - Run composer update --no-scripts command to download vendor libraries
  • Step 3 - Then run the following Artisan commands to setup laravel:
  • Create application environment config file, ".env": php -r "copy('.env.example', '.env');"
  • Generate application key: php artisan key:generate
  • Optimize application: php artisan clear-compiled php artisan optimize
  • Step 4 - Open the file .env and setup the required configurations (a MySQL database and Google Maps Api account needed).
  • Run migration code: php artisan migrate This will install an admin user with the credentials stored in your .env file for "APP_ADMIN_EMAIL" and "APP_ADMIN_PASSWORD".

Official Documentation

Coming soon.

Contributing

To be part of this project, send email to territoryapi@gmail.com

Security Vulnerabilities

If you discover a security vulnerability within Territory Services API, please send an e-mail to us.

License

Territory Services API is open-sourced software licensed under the MIT license