https://github.com/luka-lta/luka-lta-api

API for Frontend with LinkTree
https://github.com/luka-lta/luka-lta-api

api composer docker-compose factory-pattern mvc-architecture mysql nginx php php-fpm phpcs phpmd redis slimframework

Last synced: about 13 hours ago
JSON representation

API for Frontend with LinkTree

• Host: GitHub
• URL: https://github.com/luka-lta/luka-lta-api
• Owner: luka-lta
• License: mit
• Created: 2024-11-12T16:55:25.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2025-01-12T01:07:54.000Z (3 days ago)
• Last Synced: 2025-01-12T01:25:14.396Z (3 days ago)
• Topics: api, composer, docker-compose, factory-pattern, mvc-architecture, mysql, nginx, php, php-fpm, phpcs, phpmd, redis, slimframework
• Language: PHP
• Homepage: https://luka-lta.dev
• Size: 142 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# luka-lta-api

This is the official API for the projects: [luka-lta-frontend](), [luka-lta-backend](https://github.com/luka-lta/luka-lta-backend)

## Requirements:

- PHP 8.3 or higher

- Docker

- PHP-redis-extension 8.3 or higher

## Endpoints:

Default: `/api/v1/`

### Authentication:

- `POST /auth` | Authenticate user and retrieve an access token

### API Keys:

- `POST /key/create` | Generate a new API key (requires authentication)

### LinkCollection:

- `GET /linkCollection/links` | Get all available links (requires authentication)

- `POST /linkCollection/create` | Create a new link (requires authentication)

- `PUT /linkCollection/{linkId}` | Edit an existing link (requires authentication)

- `DELETE /linkCollection/{linkId}` | Disable an existing link (requires authentication)

### Clicks:

- `GET /click/track` | Track a click event

- `GET /click/all` | Get all click events (requires authentication)

### User Management:

- `POST /user/create` | Create a new user

- `POST /user/{userId}` | Update an existing user (requires authentication)

## Setup Instructions

### Installation:

1. Clone the repository:

   ```bash

   git clone https://github.com/luka-lta/luka-lta-backend.git

   cd luka-lta-backend

   ```

2. Install dependencies using Composer:

   ```bash

   composer install

   ```

3. Start the application using Docker:

   ```bash

   docker-compose up -d

   ```

4. Run database migrations:

   ```bash

   php artisan migrate

   ```

### Testing the API:

- Use tools like [Postman](https://www.postman.com/) or [cURL](https://curl.se/) to test the endpoints.