Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dickens-odera/crm-api
A REST API that should power the Agile Monkeys CRM Service
https://github.com/dickens-odera/crm-api
authentication crm docker-compose laravel laravel8 php rest-api sanctum sanctum-authentication spatie-laravel-permission
Last synced: 3 days ago
JSON representation
A REST API that should power the Agile Monkeys CRM Service
- Host: GitHub
- URL: https://github.com/dickens-odera/crm-api
- Owner: Dickens-odera
- Created: 2021-07-20T22:44:57.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-31T17:38:51.000Z (over 3 years ago)
- Last Synced: 2023-03-05T08:38:16.960Z (over 1 year ago)
- Topics: authentication, crm, docker-compose, laravel, laravel8, php, rest-api, sanctum, sanctum-authentication, spatie-laravel-permission
- Language: PHP
- Homepage: https://www.agilebackend.tujiajiriafrica.com/docs
- Size: 338 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Agile Monkeys API Backend
---
### Overview
This is a simple REST API that purposes to power the Agile Monkeys CRM service
Key Modules Implemented include:
- Authentication using [sanctum](https://laravel.com/docs/8.x/sanctum) for issuing API tokens
- Authorization using [spatie laravel permissions package](https://spatie.be/docs/laravel-permission/v4/introduction) and access control
- Role Management
- User Management
- Customer Management
### Demo URL
Please find the [demo](https://www.agilebackend.tujiajiriafrica.com/docs) url here.
### Installation
#### Prerequisites
First things first, kindly ensure that you have the following installed:
- [Git](https://git-scm.com/) for version control
- [Composer](https://getcomposer.org/download/) for dependency management
- Database Server
Clone the repository to your local development environment
```php
git clone https://github.com/Dickens-odera/crm-api.git
```
Change the directory to the clone path
```php
cd crm-api
```
then install the packages with composer
```php
composer install
```
Make a copy of the .env.example file and create a database in your db server
```php
cp .env.example .env
```
At the Created .env file add the following:
DB_USERNAME=root
DB_DATABASE=< your_database_name >
DB_PASSWORD=< your_database_password >
Generate app key
```php
php artisan key:generate
```
Modify APP_URL at the .env file to server url i.e APP_URL=http://localhost:8000 so that scribe can pick this for the endpoints
Generate API docs using the [scribe](https://scribe.readthedocs.io/en/latest/guide-getting-started.html#basic-configuration) API documentation and testing package
```php
php artisan scribe:generate
```
Run Database Migrations
```php
php artisan migrate --seed
```
This creates an admin user with the following credentials
- Email: [email protected]
- Password: admin123
Run The application
```php
php artisan serve
```
then visit http:://localhost:8000/docs to view the API docs where you will interact with the API endpoints
### How It Works
After seeding the database in the above step, use the above credentials to test the app on the [demo](https://www.agilebackend.tujiajiriafrica.com/docs) site or on your local machine
#### Access Tokens
For Authentication, this API uses the lightweight Laravel [sanctum](https://laravel.com/docs/8.x/sanctum) package to issue personal access tokens to authenticate
##### Endpoints that do not require authentication
- Login
- Register
Otherwise, all other endpoints will require you to be authenticated, to do this use the credentials above:
- Visit the documentation page at */docs* e.g http://localhost:8000/docs
- Hit The Login endpoint under Auth -> User Login on the API docs
- Copy the **accessToken** generated and
- Paste it as the **Authorization Header** for every endpoint you visit
### Run the app with Docker
If you have [docker](https://www.docker.com/products/docker-desktop) installed, run the following commands at the root folder of the project's directory
```dockerfile
docker build -t app .
docker run -p 8888:80 app
```
Have fun!