/andekata-api

Andekata API merupakan Backend untuk keperluan surat menyurat pada kelurahan yang berbasis Laravel

Primary LanguagePHP

Andekata

* version : 1.0.3-beta

* codename : yudistira

* license : MIT

About

Andekata merupakan aplikasi untuk mengolah informasi data pada sebuah Desa yang dikembangkan dengan tujuan untuk memenuhi beberapa kebutuhan mulai dari mencatat data kependudukan hingga keperluan administrasi surat menyurat. Untuk kedepannya, aplikasi ini akan terus dikembangkan dengan menyesuaikan kebutuhan yang terus bertambah.

Andekata API

Andekata API merupakan Backend sistem yang dikembangkan menggunakan framework PHP Laravel. Andekata API ini dikembangkan untuk memenuhi kebutuhan data Andekata Web Client.

Requirements

  • Composer v1.5.2
  • PHP >= 7.0.0
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Mbstring PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension
  • Redis

Installation

clone project :

  • Dengan https :
git clone https://github.com/ajaroid/andekata-api.git
  • Dengan ssh :
git clone git@github.com:ajaroid/andekata-api.git

Setup .env

Setelah clone project, pastikan terlebih dahulu mengatur konfigurasi di file .env

Catatan: Jika belum ada file .env, copy file .env.example dan beri nama .env

Atur konfigurasi database

Catatan: Pastikan sudah ada database yang siap digunakan

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=YOUR_DB_NAME
DB_USERNAME=YOUR_DB_USERNAME
DB_PASSWORD=YOUR_DB_PASSWORD

Ganti QUEUE_DRIVER menjadi redis

QUEUE_DRIVER=redis

Ganti CACHE_DRIVER menjadi redis

CACHE_DRIVER=redis

Install Dependensi

Setelah itu, install dependensi dengan menjalankan perintah berikut di folder project :

composer install

Setelah itu, jalankan perintah berikut untuk setup konfigurasi :

composer setup

Catatan: Setelah menjalankan composer setup anda akan melihat output seperti ini di terminal :

> @php artisan key:generate
Application key [base64:WvL8m2XT0PxN+NeAkN8VIDU6ndR6FTFqqR7RK/PrumI=] set successfully.
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover
Discovered Package: barryvdh/laravel-dompdf
Discovered Package: caffeinated/modules
Discovered Package: fideloper/proxy
Discovered Package: laravel/tinker
Discovered Package: maatwebsite/excel
Discovered Package: tymon/jwt-auth
Package manifest generated successfully.
> @php artisan jwt:secret -f
jwt-auth secret [FujSckTZwNVopRkqaG3CWfQfNExcjrmv] set successfully.
> @php artisan module:optimize
Generating optimized module cache
> @php artisan storage:link
The [public/storage] directory has been linked.

Database Migration

Perintah untuk migration dibedakan menjadi 2 :

  • Jika pertama kali, jalankan perintah berikut
composer new-migration-seed
  • Jika sudah pernah menjalankan perintah diatas, maka gunakan perintah berikut :
composer reset-migration-seed

mengecek sistem di lokal :

  1. sudo locale-gen id_ID.UTF-8
  2. sudo dpkg-reconfigure locales

Menjalankan Server

Untuk menjalankan server, jalankan perintah php artisan serve

Jalankan worker untuk queue php artisan queue:work --tries=3 --sleep=3

Setelah menjalankan perintah tersebut, anda bisa mencoba mengakses http://localhost:8000, dan anda akan melihat output seperti berikut :

{
    "name": "SIMDES-API",
    "version": "1.0.0",
    "created": "Sat, 21 oct 2017",
    "author": {
        "team": "ajaro.id",
        "contact": "mail@ajaro.id"
    }
}

How To Use / Testing

User Testing

Anda bisa mencoba mengakses sistem dengan menggunakan akun yg sudah tersedia secara default :

Postman Collections

  1. Import postman collections file di folder collections ke dalam postman

  2. Buat environment dan tambahkan variable berikut :

    a. BASE_API_URL untuk url api, misalnya http://localhost:8000

    b. JWT untuk token api Bearer yourtokenheregengs

Built With

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Andhika Yuana - @andhikayuana - Facebook
  • Arif Yeri Pratama - @pirey
  • Shinta Saptarini - @shintasapta
  • Syahroni - @syahrn