-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
83d12a2
commit 53e9511
Showing
1 changed file
with
156 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,160 @@ | ||
| <p align="center"><img src="https://res.cloudinary.com/dtfbvvkyp/image/upload/v1566331377/laravel-logolockup-cmyk-red.svg" width="400"></p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a> | ||
| <a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/d/total.svg" alt="Total Downloads"></a> | ||
| <a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/v/stable.svg" alt="Latest Stable Version"></a> | ||
| <a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/license.svg" alt="License"></a> | ||
| </p> | ||
|
|
||
| ## About Laravel | ||
|
|
||
| Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as: | ||
|
|
||
| - [Simple, fast routing engine](https://laravel.com/docs/routing). | ||
| - [Powerful dependency injection container](https://laravel.com/docs/container). | ||
| - Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage. | ||
| - Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent). | ||
| - Database agnostic [schema migrations](https://laravel.com/docs/migrations). | ||
| - [Robust background job processing](https://laravel.com/docs/queues). | ||
| - [Real-time event broadcasting](https://laravel.com/docs/broadcasting). | ||
|
|
||
| Laravel is accessible, powerful, and provides tools required for large, robust applications. | ||
|
|
||
| ## Learning Laravel | ||
|
|
||
| Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. | ||
|
|
||
| If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library. | ||
|
|
||
| ## Laravel Sponsors | ||
|
|
||
| We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell). | ||
|
|
||
| - **[Vehikl](https://vehikl.com/)** | ||
| - **[Tighten Co.](https://tighten.co)** | ||
| - **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** | ||
| - **[64 Robots](https://64robots.com)** | ||
| - **[Cubet Techno Labs](https://cubettech.com)** | ||
| - **[Cyber-Duck](https://cyber-duck.co.uk)** | ||
| - **[British Software Development](https://www.britishsoftware.co)** | ||
| - **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)** | ||
| - **[DevSquad](https://devsquad.com)** | ||
| - [UserInsights](https://userinsights.com) | ||
| - [Fragrantica](https://www.fragrantica.com) | ||
| - [SOFTonSOFA](https://softonsofa.com/) | ||
| - [User10](https://user10.com) | ||
| - [Soumettre.fr](https://soumettre.fr/) | ||
| - [CodeBrisk](https://codebrisk.com) | ||
| - [1Forge](https://1forge.com) | ||
| - [TECPRESSO](https://tecpresso.co.jp/) | ||
| - [Runtime Converter](http://runtimeconverter.com/) | ||
| - [WebL'Agence](https://weblagence.com/) | ||
| - [Invoice Ninja](https://www.invoiceninja.com) | ||
| - [iMi digital](https://www.imi-digital.de/) | ||
| - [Earthlink](https://www.earthlink.ro/) | ||
| - [Steadfast Collective](https://steadfastcollective.com/) | ||
| - [We Are The Robots Inc.](https://watr.mx/) | ||
| - [Understand.io](https://www.understand.io/) | ||
| - [Abdel Elrafa](https://abdelelrafa.com) | ||
| - [Hyper Host](https://hyper.host) | ||
|
|
||
| ## Contributing | ||
|
|
||
| Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). | ||
|
|
||
| ## Security Vulnerabilities | ||
|
|
||
| If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed. | ||
| <a href="https://c4c_api.mhealthkenya.co.ke"> | ||
| <img src="https://static.wixstatic.com/media/6cf925_6eea408e5e2a45afbd22d36c3e717dbd~mv2.png/v1/fill/w_243,h_280,al_c,lg_1,q_85/c4c_new.webp" alt="c4c_api"> | ||
| </a> | ||
| </p> | ||
|
|
||
| # C4C API's | ||
|
|
||
| ### Features | ||
|
|
||
| c4c_api has the following modules: <br> | ||
| 1) Registration: for registration of HCW (self-registration or register for someone else) <br> | ||
| 2) Report exposure: individual and for someone else. <br> | ||
| 3) FAQ section: Contains all frequently asked questions and their responses. <br> | ||
| 4) Learning module: Contains facility based and general learning materials for HCWs. <br> | ||
| 6) Broadcasting of messages | ||
| 7) Immunization profile: allows updating/viewing of immunization details for the HCW | ||
| 9) Checkin module: allows certain user types to checkin to a facility during their working hours | ||
| 10) Annual immunization & checkup calendar- allows viewing immunization history andsetting of annual checkup date. | ||
| 11) Report COVID-19 exposure: allows reporting of a COVID-19 exposure that the HCW may encounter | ||
|
|
||
| ## Installation | ||
|
|
||
| Please check the official laravel installation guide for server requirements before you start. [Official Documentation](https://laravel.com/docs/5.8/installation#installation) | ||
|
|
||
| Alternative installation is possible without local dependencies relying on [Docker](#docker). | ||
|
|
||
| Clone the repository | ||
|
|
||
| git clone https://github.com/mHealthKenya/c4c_api.git | ||
|
|
||
| Switch to the repo folder | ||
|
|
||
| cd c4c_api | ||
|
|
||
| Install all the dependencies using composer | ||
|
|
||
| composer install | ||
|
|
||
| Copy the example env file and make the required configuration changes in the .env file | ||
|
|
||
| cp .env.example .env | ||
|
|
||
| Generate a new application key | ||
|
|
||
| php artisan key:generate | ||
|
|
||
| Generate a new JWT authentication secret key | ||
|
|
||
| php artisan jwt:generate | ||
|
|
||
| Run the database migrations (**Set the database connection in .env before migrating**) | ||
|
|
||
| php artisan migrate | ||
|
|
||
| Create a public and private key in the storage folder | ||
| oauth-private.key | ||
| oauth-public.key | ||
|
|
||
| Start the local development server | ||
|
|
||
| php artisan serve | ||
|
|
||
| You can now access the server at http://localhost:8000 | ||
|
|
||
| **TL;DR command list** | ||
|
|
||
| git clone https://github.com/mHealthKenya/c4c_api.git | ||
| cd c4c_api | ||
| composer install | ||
| cp .env.example .env | ||
| php artisan key:generate | ||
| php artisan jwt:generate | ||
|
|
||
|
|
||
| **Make sure you set the correct database connection information before running the migrations** [Environment variables](#environment-variables) | ||
|
|
||
| php artisan migrate | ||
| php artisan serve | ||
|
|
||
| ## Dependencies | ||
|
|
||
| - [jwt-auth](https://github.com/tymondesigns/jwt-auth) - For authentication using JSON Web Tokens | ||
| - [laravel-cors](https://github.com/barryvdh/laravel-cors) - For handling Cross-Origin Resource Sharing (CORS) | ||
| - [africastalking](https://github.com/AfricasTalkingLtd/africastalking-php) - For SMS | ||
|
|
||
| ## Folders | ||
|
|
||
| - `app` - Contains all the Eloquent models | ||
| - `app/Http/Controllers` - Contains all the api controllers | ||
| - `app/Http/Middleware` - Contains the JWT auth middleware | ||
| - `app/Http/Helpers` - Contains the helper functions | ||
| - `app/Http/Jobs` - Contains the functions for creating queued jobs | ||
| - `app/Http/Controllers/Api` - Contains all the api controllers | ||
| - `app/Http/Controllers/Api/UserController.php` - Contains the functions implementing the user module | ||
| - `app/Http/Controllers/Api/ResourcesController.php` - Contains the functions implementing the resource center module | ||
| - `app/Http/Controllers/Api/ImmunizationController.php` - Contains the functions implementing the immunization module | ||
| - `app/Http/Controllers/Api/ImmunizationController.php` - Contains the functions implementing the immunization module | ||
| - `app/Http/Controllers/BroadcastsController.php` - Contains the functions implementing the broadcasts module | ||
| - `app/Http/Controllers/DataController.php` - Contains the functions and queries for the highcharts | ||
| - `config` - Contains all the application configuration files | ||
| - `database/factories` - Contains the model factory for all the models | ||
| - `database/migrations` - Contains all the database migrations | ||
| - `routes/api` - Contains all the api routes | ||
| - `tests` - Contains all the application tests | ||
|
|
||
| ## Environment variables | ||
|
|
||
| - `.env` - Environment variables can be set in this file | ||
|
|
||
| ***Note*** : You can quickly set the database information and other variables in this file and have the application fully working. | ||
|
|
||
| ---------- | ||
|
|
||
| # Testing API | ||
|
|
||
| Run the laravel development server | ||
|
|
||
| php artisan serve | ||
|
|
||
| The api can now be accessed at | ||
|
|
||
| http://localhost:8000/api | ||
|
|
||
| Request headers | ||
|
|
||
| | **Required** | **Key** | **Value** | | ||
| |---------- |------------------ |------------------ | | ||
| | Yes | Content-Type | application/json | | ||
| | Yes | X-Requested-With | XMLHttpRequest | | ||
| | Optional | Authorization | Token {JWT} | | ||
|
|
||
| Refer the [api specification](#api-specification) for more info. | ||
|
|
||
| ---------- | ||
|
|
||
| # Authentication | ||
|
|
||
| This applications uses JSON Web Token (JWT) to handle authentication. The token is passed with each request using the `Authorization` header with `Token` scheme. The JWT authentication middleware handles the validation and authentication of the token. Please check the following sources to learn more about JWT. | ||
|
|
||
| - https://jwt.io/introduction/ | ||
| - https://self-issued.info/docs/draft-ietf-oauth-json-web-token.html | ||
| ---------- | ||
|
|
||
| # Cross-Origin Resource Sharing (CORS) | ||
|
|
||
| This applications has CORS enabled by default on all API endpoints. The default configuration allows requests from `http://localhost:3000` and `http://localhost:4200` to help speed up your frontend testing. The CORS allowed origins can be changed by setting them in the config file. Please check the following sources to learn more about CORS. | ||
|
|
||
| - https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS | ||
| - https://en.wikipedia.org/wiki/Cross-origin_resource_sharing | ||
| - https://www.w3.org/TR/cors | ||
| ## Dependencies | ||
|
|
||
| - [laravel-cors](https://github.com/barryvdh/laravel-cors) - For handling Cross-Origin Resource Sharing (CORS) | ||
|
|
||
| ## License | ||
|
|
||
| The Laravel framework is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT). | ||
| [](#) | ||
|
|
||
| [](#) |