diff --git a/README.md b/README.md index a547971..a43cac7 100644 --- a/README.md +++ b/README.md @@ -8,83 +8,74 @@
License + Commits - + Visit memegoat.fr
-
-

- - Follow on LinkedIn - - - Join our Discord - -

-
# 🐐 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: -- **API**: [Documentation](#) -- **Data Model**: [MLD/LDM](#), [MCD/CDM](#), [MPD/PDM](#) -- **Technical choices**: [The stack](#), [Security choices](#), [Docker](#) +## Documentation Rapide -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 -- **The hard stuff**: proxies, anti-bot mechanisms, dynamic content (js-rendered), output parsing, orchestration -- -### anchor +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). -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. - -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. +## Licence +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.

- ↑ Back to Top ↑ + ↑ Retour en haut ↑

\ No newline at end of file