Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/domexx/ares
Base project for creating fast and convenient web apis build on slim micro-framework
https://github.com/domexx/ares
api cache fastapi php php8 slim-framework slim4 slim4-skeleton
Last synced: 24 days ago
JSON representation
Base project for creating fast and convenient web apis build on slim micro-framework
- Host: GitHub
- URL: https://github.com/domexx/ares
- Owner: Domexx
- License: mit
- Created: 2020-11-16T19:48:26.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-18T13:23:24.000Z (almost 4 years ago)
- Last Synced: 2024-10-14T19:40:33.578Z (24 days ago)
- Topics: api, cache, fastapi, php, php8, slim-framework, slim4, slim4-skeleton
- Language: PHP
- Homepage:
- Size: 29.3 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Ares
[](https://www.codefactor.io/repository/github/domexx/ares/overview/master) [](https://github.com/Domexx/aresd/blob/master/LICENSE)
==========================
## Introduction
This project is based on the micro framework slim.
It can be used for creating and expanding fast apis.
## Base Features:
- Responses
- Exceptions
- Validation
- Authentication
- Locales & Translations
- Cache
- Request Throttle
- Database
- Illuminate QueryBuilder
- Slugs
- Configs
- Dotenv
- Logging
- DI Container
- Routing (Slim)
## Installation
##### 1. Clone / Require project.
```console
$ git clone https://github.com/Domexx/ares.git
or
$ composer require domexx/ares
```
##### 2. Change directory to project.
```console
$ cd ares
```
##### 3. Copy dotenv config.
```console
$ cp .env.example .env
```
##### 4. Install composer dependencies.
```console
$ composer install
```
##### 5. Give rights to the folder.
```console
$ chmod -R 775 {dir name}
```
## Configuration
##### Configure your .env:
```text
# Database Credentials
DB_HOST=db
DB_PORT=db
DB_NAME="ares"
DB_USER="ares"
DB_PASSWORD="your_password"
# development / production
API_DEBUG="production"
WEB_NAME="Ares"
# Defines the link to your frontend application // For CORS purpose (*) to allow all
WEB_FRONTEND_LINK="*"
# 1 = Enabled, 0 = Disabled
CACHE_ENABLED=1
# "Files" for Filecache, "Predis" for Redis
CACHE_TYPE="Files"
# Defines the cache alive time in seconds
CACHE_TTL=950
# Redis Host
CACHE_REDIS_HOST=127.0.0.1
# Redis Port, standard Port is 6379
CACHE_REDIS_PORT=6379
# Only works with Redis // Enables Throttling // Enables that people only can call the endpoint certain times in a short period
THROTTLE_ENABLED=0
TOKEN_ISSUER="Ares-Issuer"
TOKEN_DURATION=86400
# The secret must be at least 12 characters in length; contain numbers; upper and lowercase letters; and one of the following special characters *&!@%^#$
TOKEN_SECRET="Secret123!456$"
```
## Expand project
### Create custom Module:
##### 1. Create controller class which extends BaseController
In the controller class you can define functions that are called by calling a route,
which can be defined in the app/routes/routes.php.
Auth protected routes can be used with setting middleware 'AuthMiddleware',
between route path and route action call.
```php
respond(
$response,
response()
->setData($customResponse)
);
}
}
```
##### 2. Register your custom route in app/routes.php that calls a controller function
```php
return function (App $app) {
// Registers our custom routes that calls the customResponse function in our custom controller
$app->get('/custom', \Ares\CustomModule\Controller\Controller::class . ':customResponse');
};
```
### Create custom Service Provider:
##### 1. Create new Service Provider with extending AbstractServiceProvider
```php
getContainer();
$container->add(Custom::class, function () {
return new Custom();
});
}
}
```
##### 2. Register the new created Service Provider in app/etc/providers.php
```php
// Adds our CustomProvider to add Customs
$container->addServiceProvider(
new \Ares\CustomModule\Provider\CustomServiceProvider()
);
```
## Credits
If you got questions or feedback feel free to contact us.
- Discord: Dome#9999
- Mail: [email protected]
----------------------------------
- Discord: s1njar#0066
- Mail: [email protected]
## Links
- [Slim Framework](https://www.slimframework.com/)
- [Ares Core Module](https://github.com/Domexx/Ares-Core.git)
## License
The MIT License (MIT).