Skip to content

TrakaMeitene/laravel-backend

Repository files navigation

⚡ Laravel Backend API

GitHub stars

GitHub forks

GitHub issues

GitHub license

PHP Version

A robust and scalable backend API built with Laravel.

📖 Overview

Pierakstspie API is a Laravel-based backend that powers the Pierakstspie.lv booking platform, providing secure authentication (Laravel Sanctum), user and role management, client and contact handling with custom fields, service and schedule management, and integration with a Next.js frontend, and extensions such as invoicing and financial reporting.

🛠️ Tech Stack

  • Backend:
    • Laravel
    • PHP
    • MySQL

🚀 Quick Start

Prerequisites

  • PHP >= 8.1
  • Composer
  • A MySQL database server

Installation

  1. Clone the repository:

    git clone https://github.com/TrakaMeitene/laravel-backend.git
    cd laravel-backend
  2. Install dependencies:

    composer install
    npm install
  3. Configure environment:

    cp .env.example .env
    # Configure database credentials and other environment variables in .env
  4. Generate application key:

    php artisan key:generate
  5. Database migrations:

    php artisan migrate
  6. Start the development server (if applicable, depends on app specifics):

    php artisan serve

📁 Project Structure

laravel-backend/
├── app/
├── artisan
├── bootstrap/
├── config/
├── database/
│   ├── migrations/
│   └── seeders/
├── lang/
├── package-lock.json
├── package.json
├── phpunit.xml
├── public/
├── resources/
├── routes/
├── storage/
├── tests/
└── vite.config.js

⚙️ Configuration

Configuration is primarily managed through the .env file (created by copying .env.example). This file contains database credentials, API keys, and other environment-specific settings. Laravel's built-in configuration system is also used, with settings stored within the config directory.

Environment Variables (Example from .env.example)

The .env.example file provides examples of required environment variables. These should be populated in the .env file before running the application. Specific variables and their purpose will depend on the features of this particular application.

🧪 Testing

The project utilizes PHPUnit for testing. Test cases are located in the tests directory. To run tests:

./vendor/bin/phpunit

📄 License

This project is NOT licensed

Made with ❤️ by TrakaMeitene

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors