{"id":20294067,"url":"https://github.com/dickens-odera/crm-api","last_synced_at":"2026-05-04T17:34:39.591Z","repository":{"id":48336350,"uuid":"387930527","full_name":"Dickens-odera/crm-api","owner":"Dickens-odera","description":"A REST API that should power the Agile Monkeys CRM Service","archived":false,"fork":false,"pushed_at":"2021-07-31T17:38:51.000Z","size":346,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-01T18:46:50.954Z","etag":null,"topics":["authentication","crm","docker-compose","laravel","laravel8","php","rest-api","sanctum","sanctum-authentication","spatie-laravel-permission"],"latest_commit_sha":null,"homepage":"https://www.agilebackend.tujiajiriafrica.com/docs","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dickens-odera.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-20T22:44:57.000Z","updated_at":"2021-07-31T17:45:56.000Z","dependencies_parsed_at":"2022-08-24T14:49:43.363Z","dependency_job_id":null,"html_url":"https://github.com/Dickens-odera/crm-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Dickens-odera/crm-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dickens-odera%2Fcrm-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dickens-odera%2Fcrm-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dickens-odera%2Fcrm-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dickens-odera%2Fcrm-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dickens-odera","download_url":"https://codeload.github.com/Dickens-odera/crm-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dickens-odera%2Fcrm-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32617979,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"ssl_error","status_checked_at":"2026-05-04T10:08:02.005Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authentication","crm","docker-compose","laravel","laravel8","php","rest-api","sanctum","sanctum-authentication","spatie-laravel-permission"],"created_at":"2024-11-14T15:27:28.419Z","updated_at":"2026-05-04T17:34:39.569Z","avatar_url":"https://github.com/Dickens-odera.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Agile Monkeys API Backend\n---\n\n### Overview\nThis is a simple REST API that purposes to power the Agile Monkeys CRM service\u003cbr\u003e \nKey Modules Implemented include:\n- Authentication using [sanctum](https://laravel.com/docs/8.x/sanctum) for issuing API tokens\n- Authorization using [spatie laravel permissions package](https://spatie.be/docs/laravel-permission/v4/introduction) and access control\n- Role Management\n- User Management\n- Customer Management\n\n### Demo URL\nPlease find the [demo](https://www.agilebackend.tujiajiriafrica.com/docs) url here.\n\n### Installation\n#### Prerequisites\nFirst things first, kindly ensure that you have the following installed:\n\n- [Git](https://git-scm.com/) for version control\n- [Composer](https://getcomposer.org/download/) for dependency management\n- Database Server\n\nClone the repository to your local development environment\n```php\ngit clone https://github.com/Dickens-odera/crm-api.git\n```\nChange the directory to the clone path\n```php\ncd crm-api\n```\nthen install the packages with composer\n```php\ncomposer install\n```\n\nMake a copy of the .env.example file and create a database in your db server\n```php\ncp .env.example .env\n```\n\u003cp\u003eAt the Created .env file add the following:\u003c/p\u003e\nDB_USERNAME=root\u003cbr\u003e\nDB_DATABASE=\u003c your_database_name \u003e\u003c/br\u003e\nDB_PASSWORD=\u003c your_database_password \u003e\n\nGenerate app key\n```php\nphp artisan key:generate\n```\nModify 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\u003cbr\u003e\n\nGenerate API docs using the [scribe](https://scribe.readthedocs.io/en/latest/guide-getting-started.html#basic-configuration) API documentation and testing package\n```php\nphp artisan scribe:generate\n```\nRun Database Migrations\n```php\nphp artisan migrate --seed\n```\nThis creates an admin user with the following credentials\n- Email: admin@agilemonkeys.com\n- Password: admin123\n\nRun The application\n```php\nphp artisan serve\n```\nthen visit http:://localhost:8000/docs to view the API docs where you will interact with the API endpoints\n### How It Works\nAfter 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\n\n#### Access Tokens\nFor Authentication, this API uses the lightweight Laravel [sanctum](https://laravel.com/docs/8.x/sanctum) package to issue personal access tokens to authenticate\n\n##### Endpoints that do not require authentication\n- Login\n- Register\n\nOtherwise, all other endpoints will require you to be authenticated, to do this use the credentials above:\n- Visit the documentation page at */docs* e.g http://localhost:8000/docs\n- Hit The Login endpoint under Auth -\u003e User Login on the API docs\n- Copy the **accessToken** generated and \n- Paste it as the **Authorization Header** for every endpoint you visit\n\n### Run the app with Docker\nIf you have [docker](https://www.docker.com/products/docker-desktop) installed, run the following commands at the root folder of the project's directory\n```dockerfile\ndocker build -t app .\ndocker run -p 8888:80 app\n```\nHave fun!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdickens-odera%2Fcrm-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdickens-odera%2Fcrm-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdickens-odera%2Fcrm-api/lists"}