Giter Club home page Giter Club logo

pierrestudios / territory-api Goto Github PK

View Code? Open in Web Editor NEW
2.0 3.0 1.0 2.7 MB

Territory Services API is a RESTful api built with Laravel to provide easy 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.

PHP 71.13% HTML 0.27% Hack 10.13% Shell 0.12% Procfile 0.01% SCSS 0.02% Blade 18.32%
php7 jwt dompdf rest-api one-to-many pdf-generation google-maps-api geolocation laravel

territory-api's Introduction

Territory Services API

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

Core Services

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

Core Entities

  • publishers: name, type (pioneer, regular) Relationships with user Crud

  • users: email, publisher, type, date Relationships with publisher Crud

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

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

  • notes: content, user, type Relationships with many Crud

  • phones: name, number, status Relationships with addresses, notes Crud

Additional Services

  • Generate PDF
  • Address coordinates
  • Map render with Google Maps

Installation

  • Step 1 - Clone this repository into your dev directory
  • Step 2 - Run composer install command
  • 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 add the required configurations (a MySQL database and Google Maps Api key with no HTTP restrictions 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

https://www.territory-app.net/

Contributing

To be part of this project, send email to [email protected]

Security Vulnerabilities

If you discover a security vulnerability within Territory Services API, please send an e-mail to me at, [email protected].

License

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

territory-api's People

Contributors

pierrestudios avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

gigi955

territory-api's Issues

Android request not working

Hi I just trying to use this Rest Api for Android App. but this APIs not responding for android app. But Postman requests working properly.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.