Skip to content

atulshrma91/swagger-erp

Repository files navigation

Swagger ERP

Installation - run following commands:

docker run --rm \
-u "$(id -u):$(id -g)" \
-v $(pwd):/var/www/html \
-w /var/www/html \
laravelsail/php81-composer:latest \
sudo mkdir -p /var/www/html/vendor && \
composer install --ignore-platform-reqs
./vendor/bin/sail up

Overview

Swagger ERP is a Laravel-based API providing endpoints for authentication, referrals, tasks, billing, and therapist visit flows. Interactive API documentation is available via L5 Swagger.

Tech Stack

  • Laravel 9 (PHP 8.1)
  • PostgreSQL
  • Docker + Laravel Sail
  • L5 Swagger for API docs
  • AWS CDK (TypeScript) in cdk/

Prerequisites

  • Docker and Docker Compose installed
  • Node.js (only if working with cdk/)

Environment Setup

cp .env.example .env
./vendor/bin/sail artisan key:generate

Database Migration and Seeding

./vendor/bin/sail artisan migrate --seed

Accessing API Docs

  • Open http://localhost/api/documentation

Testing

./vendor/bin/sail test

Code Style

./vendor/bin/pint

Project Structure

  • app/ application code (controllers, models, components)
  • config/ configuration (app, database, services)
  • routes/ route definitions (web.php redirects to API docs)
  • resources/ views, emails, and assets
  • database/ migrations and seeders
  • cdk/ AWS CDK infrastructure (staging configuration)

Infrastructure (optional)

From cdk/ directory:

npm install
npm run build
npm run cdk synth

About

Laravel Api with Swagger

Topics

Resources

Stars

Watchers

Forks

Contributors

Languages