https://github.com/darkweak/souin-website
An UI to manage HTTP cache using Souin free as in beer.
https://github.com/darkweak/souin-website
Last synced: about 1 month ago
JSON representation
An UI to manage HTTP cache using Souin free as in beer.
- Host: GitHub
- URL: https://github.com/darkweak/souin-website
- Owner: darkweak
- License: mit
- Created: 2023-07-11T09:20:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-09T07:34:14.000Z (about 2 years ago)
- Last Synced: 2025-02-24T00:17:44.412Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://souin.io
- Size: 476 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Souin website
**Currently in beta**
Souin website is the [Souin](https://github.com/darkweak/souin) SaaS web UI platform. It allow users to setup and manage the Souin HTTP cache on a proxied server.
## Author
[@darkweak](https://github.com/darkweak)
## Dependencies
* PHP >= 8.1
* Node.js v18.16.0
* PostgreSQL v15.3
## Install project
Clone the project
```bash
git clone https://github.com/darkweak/souin-website
```
Go to the project directory
```bash
cd souin-website
```
### Docker
This project uses docker to deploy so before the next steps, make sur to install docker [here](https://docs.docker.com/engine/install/).
You can now run all the containers using
in dev:
```bash
make start-dev
```
in prod:
```bash
make start-prod
```
### Install dependencies
on api:
```bash
composer install
```
on pwa:
```bash
pnpm install
```
## API
This project uses API Platform, here is the CDM of the project:
You can fill the API with fixtures using:
```bash
make reset-db
```
## JWT Authentication
This project uses the JWT Authentication so you need to generate the RSA keys using:
```bash
make generate-jwt
```
## Running Tests
To run tests, run the following command
PHPstan:
```bash
make analyse
```
PHP-cs-fixer:
```bash
make cs-fixer
```