The api-spip from dryastr

API SPIP

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Documentation
Changelog
Queue

## About The Project API SPIP Domain: * spip.com

### Built With This service uses the PHP programming language and uses several libraries. **Programming language:** - PHP (8.2) - Node JS (18.6) **Framework:** - Laravel (10) **Plugin/Library:** - Husky - Git Hook For Commit Lint - Chokidar - Hot Reload OpenSwoole - mifx-package/mifx-core - Package Internal MIFX - laravel/octane - Octane(Swoole Server Library) - doctrine/dbal - Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management - php-open-source-saver/jwt-auth - PHP Open Source - JWT Auth (Generate & Validate JWT) - predis/predis - A flexible and feature-complete Redis client for PHP - spatie/laravel-ignition - A beautiful error page for Laravel applications. - symfony/http-kernel - Provides a structured process for converting a Request into a Response - vladimir-yuldashev/laravel-queue-rabbitmq - RabbitMq (Message Broker) **Plugin/Library development only:** - pestphp/pest - Pest (Unit Testing) - barryvdh/laravel-ide-helper - Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion. - laravel/pint - An opinionated code formatter for PHP. - laravel/sail - Docker files for running a basic Laravel application.

(back to top)

## Getting Started This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps. ### Prerequisites This is an example of how to list things you need to use the software and how to install them. * npm ```sh npm install [email protected] -g ``` * swoole ``` sh pecl install openswoole ``` * docker - https://docs.docker.com/desktop/install/mac-install/ * composer - https://getcomposer.org/download/ * xdebug - https://xdebug.org/docs/install/#pecl ### Installation #### With Docker 1. Clone the project ```bash git clone ``` 2. Go to the project directory ```bash cd api-{service-name} ``` 3. Create database MYSQL `spip` 4. Setup .env at env {service-name} 5. Install app and dependencies ```bash composer install ``` ```bash npm install ``` 6. Migration & Seed ```bash php artisan migrate --seed ``` 7. Build with docker ```bash docker-compose build ``` 8. Start the server ```bash docker-compose up ``` 9. You can now access the server at http://localhost:8012/ 10. You can now access the Clockwork server at http://localhost:8012/clockwork #### Without Docker 1. Clone the project ```bash git clone https://repo.mifx.com/micro-services/api-{service-name} ``` 2. Go to the project directory ```bash cd api-{service-name} ``` 3. Create database MYSQL `spip` 4. Setup .env at env {service-name} 5. Install app and dependencies ```bash composer install ``` ```bash npm install ``` 6. Migration & Seed ```bash php artisan migrate --seed ``` 7. Start the server ```bash php artisan octane:start --watch --server=swoole ``` 8. You can now access the server at http://localhost:8000/

(back to top)

### Running Tests 1. Create database PostgreSQL `spip_testing` 2. Setup .env.testing at env {service-name} 3. Run tests ```bash sh test.sh ``` ## Usage You can now access the server with docker at http://localhost:8080.
You can now access the server without docker at http://localhost:8000.

(back to top)

## Documentation You can study some documentation related to this service - Coming soon

dryastr / api-spip Goto Github PK

api-spip's Introduction

API SPIP

api-spip's People

Contributors

Watchers

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent