https://github.com/asilvafx/free-api

Fat-Free API - PHP Framework
https://github.com/asilvafx/free-api

authn cms f3 fatfree framework lightweight mvc php rest-api vanilla

Last synced: 4 months ago
JSON representation

Fat-Free API - PHP Framework

• Host: GitHub
• URL: https://github.com/asilvafx/free-api
• Owner: asilvafx
• License: mit
• Created: 2024-11-04T18:25:54.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-26T20:57:40.000Z (about 1 year ago)
• Last Synced: 2025-01-26T21:28:13.547Z (about 1 year ago)
• Topics: authn, cms, f3, fatfree, framework, lightweight, mvc, php, rest-api, vanilla
• Language: PHP
• Homepage:
• Size: 3.79 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# Free API

![Maintenance](https://img.shields.io/maintenance/yes/2025?logo=github)

![PHP Version](https://img.shields.io/badge/php-%3E%3D8.0-blue)

![SQLite](https://img.shields.io/badge/sqlite-v3.36.0-green)

## Overview

Welcome to the Free API project! This is a PHP API backend built using the F3 Fat-Free Framework. The goal of this project is to provide a robust and easy-to-implement backend framework that supports REST API, Secure authentication, MVC architecture, Databases, and a user-friendly administration layout.

## Features

- **REST API**: Easily create and manage RESTful CRUD (Create, Read, Update and Delete) services.

- **Bearer Tokens Authentication**: Secure your API http authorization requests.

- **MVC Architecture**: Organize your code with the Model-View-Controller pattern.

- **Emails**: Connect email to your SMTP server to send emails via API.

- **Payments**: Stripe API and PayPal API integrated.

- **Files Management**: Dedicated area to manage uploaded files. Download and upload files via API.

- **SQLite Database Management**: Lightweight and easy-to-use database solution with visual editor.

- **User Access**: Implement user registration, login and roles based functionalities.

- **Two-Factor Authentication (2-FA)**: Enhance security with an additional layer of authentication.

- **WebAuthn**: Support for modern passwordless authentication methods.

- **User-Friendly UI/UX**: An intuitive administration panel for easy management and customization.

- **Security**: Enhanced security protocols via htaccess and PHP calls to prevent cyber attacks.

## Installation

To get started with the Free API, follow these steps:

1. **Clone the Repository**:

   ```

   git clone https://github.com/asilvafx/free-api.git

   cd free-api

   ```

2. **Install Dependencies**:

   ``` 

   composer install 

   ```

3. **Run Application**:

   ``` 

   Upload the files to your FTP server or Run locally (XAMPP, MAMP, ..), and follow the setup wizzard instructions on your browser! 

   ```