docs: update README with new platform details and usage instructions
Revamped the README to include updated descriptions of Memegoat's features, architecture, technical stack, installation steps, and key documentation links.
This commit is contained in:
83
README.md
83
README.md
@@ -8,83 +8,74 @@
|
|||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://git.yidhra.fr/Mathis/memegoat/src/branch/dev/LICENSE">
|
<a href="https://git.yidhra.fr/Mathis/memegoat/src/branch/dev/LICENSE">
|
||||||
<img src="https://img.shields.io/badge/License-AGPL3.0-green" alt="License">
|
<img src="https://img.shields.io/badge/License-AGPL3.0-green" alt="License">
|
||||||
|
</a>
|
||||||
<a href="https://git.yidhra.fr/Mathis/memegoat/commits">
|
<a href="https://git.yidhra.fr/Mathis/memegoat/commits">
|
||||||
<img src="https://img.shields.io/badge/Status-Ongoing-blue" alt="Commits">
|
<img src="https://img.shields.io/badge/Status-Ongoing-blue" alt="Commits">
|
||||||
</a>
|
</a>
|
||||||
<a href="https://memegoat.fr?ref=git">
|
<a href="https://memegoat.fr">
|
||||||
<img src="https://img.shields.io/badge/Visit-memegoat.fr-orange" alt="Visit memegoat.fr">
|
<img src="https://img.shields.io/badge/Visit-memegoat.fr-orange" alt="Visit memegoat.fr">
|
||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
|
||||||
<p align="center">
|
|
||||||
<a href="#">
|
|
||||||
<img src="https://img.shields.io/badge/Follow%20me%20on%20LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" alt="Follow on LinkedIn" />
|
|
||||||
</a>
|
|
||||||
<a href="#">
|
|
||||||
<img src="https://img.shields.io/badge/Join%20my%20Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Join our Discord" />
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
# 🐐 Memegoat
|
# 🐐 Memegoat
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet
|
Memegoat est une plateforme moderne de partage et de création de mèmes, conçue avec une architecture robuste et sécurisée.
|
||||||
|
|
||||||
_This repository is in development, and we’re still integrating core feature into the mono repo. It's not fully ready for self-hosted deployment yet, but you can run it locally._
|
_Ce dépôt est en cours de développement. Nous intégrons actuellement les fonctionnalités clés dans le monorepo. Il n'est pas encore totalement prêt pour un déploiement auto-hébergé simplifié, mais vous pouvez le lancer localement._
|
||||||
|
|
||||||
## What is Memegoat ?
|
## Qu'est-ce que Memegoat ?
|
||||||
|
|
||||||
[Firecrawl](https://memegoat.fr?ref=git) Lorem ipsum dolor sit amet. Check out our [documentation](https://docs.memegoat.fr).
|
[Memegoat](https://memegoat.fr) est votre destination ultime pour découvrir, créer et partager les meilleurs mèmes du web. Notre plateforme se concentre sur la performance, la sécurité des données et une expérience utilisateur fluide.
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet
|
Retrouvez notre documentation complète sur : [docs.memegoat.fr](https://docs.memegoat.fr)
|
||||||
|
|
||||||
_Pst. hey, you, join our stargazers :)_
|
## Architecture & Stack Technique
|
||||||
|
|
||||||
## How to use it?
|
Le projet est structuré en monorepo :
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet. You can also self host if you'd like.
|
- **Frontend** : Next.js avec Tailwind CSS et Shadcn/ui.
|
||||||
|
- **Backend** : NestJS (TypeScript) avec PostgreSQL.
|
||||||
|
- **Base de données** : Drizzle ORM avec chiffrement natif PGP pour les données sensibles.
|
||||||
|
- **Infrastructure** : Docker, Caddy (Reverse Proxy & TLS), stockage compatible S3.
|
||||||
|
|
||||||
Check out the following resources to get started:
|
## Documentation Rapide
|
||||||
- **API**: [Documentation](#)
|
|
||||||
- **Data Model**: [MLD/LDM](#), [MCD/CDM](#), [MPD/PDM](#)
|
|
||||||
- **Technical choices**: [The stack](#), [Security choices](#), [Docker](#)
|
|
||||||
|
|
||||||
To run locally, refer to guide [here](#).
|
Pour approfondir vos connaissances techniques sur le projet :
|
||||||
|
- **[Modèle de Données](https://docs.memegoat.fr/docs/database)** : MCD, MLD et MPD.
|
||||||
|
- **[Sécurité](https://docs.memegoat.fr/docs/security)** : Chiffrement PGP, Argon2id, RBAC.
|
||||||
|
- **[Conformité RGPD](https://docs.memegoat.fr/docs/compliance)** : Mesures techniques et droits des utilisateurs.
|
||||||
|
- **[API & Intégrations](https://docs.memegoat.fr/docs/api)** : Authentification par sessions, clés API et 2FA.
|
||||||
|
|
||||||
### API Key
|
## Comment l'utiliser ?
|
||||||
|
|
||||||
To use the API, you need to sign up on [Memegoat](https://memegoat.fr) and get an API key.
|
### Installation locale
|
||||||
|
|
||||||
### Features
|
1. Clonez le dépôt.
|
||||||
|
2. Installez les dépendances avec `pnpm install`.
|
||||||
|
3. Configurez les variables d'environnement (voir `.env.example`).
|
||||||
|
4. Lancez les services via Docker ou manuellement.
|
||||||
|
|
||||||
- [**Blank**](#anchor): lorem ipsum
|
### Clés API
|
||||||
|
|
||||||
### Powerful Capabilities
|
Pour utiliser l'API, vous pouvez générer des clés API sécurisées directement depuis votre profil sur [memegoat.fr](https://memegoat.fr).
|
||||||
- **The hard stuff**: proxies, anti-bot mechanisms, dynamic content (js-rendered), output parsing, orchestration
|
|
||||||
-
|
|
||||||
### anchor
|
|
||||||
|
|
||||||
lorem ipsum
|
## Fonctionnalités Clés
|
||||||
|
|
||||||
## Contributing
|
- **Sécurité Avancée** : Chiffrement des données personnelles au repos et hachage aveugle pour la recherche.
|
||||||
|
- **RGPD by Design** : Mécanismes de Soft Delete, purge automatique et hachage des IPs.
|
||||||
|
- **Multi-Authentification** : Support des sessions JWT, des clés API et de la double authentification (2FA).
|
||||||
|
- **Gestion de Contenu** : Support des mèmes et GIFs avec système de tags et signalements.
|
||||||
|
|
||||||
We love contributions! Please read our [contributing guide](CONTRIBUTING.md) before submitting a pull request. If you'd like to self-host, refer to the [self-hosting guide](SELF_HOST.md).
|
## Contribution
|
||||||
|
|
||||||
## License Disclaimer
|
Les contributions sont les bienvenues ! Veuillez consulter notre guide de contribution avant de soumettre une pull request.
|
||||||
|
|
||||||
This project is primarily licensed under the GNU Affero General Public License v3.0 (AGPL-3.0), as specified in the LICENSE file in the root directory of this repository. However, certain components of this project are licensed under the MIT License. Refer to the LICENSE files in these specific directories for details.
|
## Licence
|
||||||
|
|
||||||
Please note:
|
|
||||||
|
|
||||||
- The AGPL-3.0 license applies to all parts of the project unless otherwise specified.
|
|
||||||
- The SDKs and some UI components are licensed under the MIT License. Refer to the LICENSE files in these specific directories for details.
|
|
||||||
- When using or contributing to this project, ensure you comply with the appropriate license terms for the specific component you are working with.
|
|
||||||
|
|
||||||
For more details on the licensing of specific components, please refer to the LICENSE files in the respective directories or contact the project maintainers.
|
|
||||||
|
|
||||||
|
Ce projet est principalement sous licence **GNU Affero General Public License v3.0 (AGPL-3.0)**. Certains composants, comme les SDKs, peuvent être sous licence MIT. Veuillez vous référer aux fichiers `LICENSE` dans les répertoires respectifs pour plus de détails.
|
||||||
|
|
||||||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||||||
<a href="#readme-top" style="text-decoration: none; color: #007bff; font-weight: bold;">
|
<a href="#readme-top" style="text-decoration: none; color: #007bff; font-weight: bold;">
|
||||||
↑ Back to Top ↑
|
↑ Retour en haut ↑
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
Reference in New Issue
Block a user