This is the backend repository for the PostCare app, built using Laravel, a PHP framework, MySQL database and StreamChat API (for realtime messaging).
- User authentication: Patients and Medical Providers registration
- Creating and assigning of tasks to patients by registered Medical providers
- Realtime messaging between patients and providers
- CRUD operations on Recovery plans
- PHP >= 8.0
- MySQL >= 8.0
- Composer
- Laravel >= 9.0
- Postman
- A Stream account
- Clone this repository to your local machine using the following command:
git clone https://github.com/PostOP-app/postcare-backend.git
- Navigate to the project directory:
cd postcare-backend
- Install dependencies using Composer:
composer install
-
Copy the .env.example file to a new file named .env:
cp .env.example .env -
Generate an encryption key for Laravel:
php artisan key:generate -
Update the .env file with your database credentials and other configuration options.
-
Run the database migrations:
php artisan migrate
- Run the following command to install Laravel Passport keys:
php artisan passport:install
- Start the built-in PHP server:
php artisan serve
- Open your Postman app. The API endpoints can be accessed from here.
Run the following command in the project root directory to reveal the API endpoints:
php artisan route:list
- Fork this repository
- Create a new branch for your changes (e.g. feature/new-feature)
- Commit your changes
- Push to your fork and submit a pull request
This project is licensed under the MIT License. See the LICENSE file for details.