chore: clean complet du projet et ajout d'un README avec licence personnelle
- Suppression de tous les scripts de migration temporaires (fix_*.py, update_*.py, etc) - Suppression des fichiers d'expérimentation html/json et .txt - Modification du README: ajout d'une section licence usage non-commercial - Modification du README: ajout d'une roadmap pour un déploiement public SaaS avec PostgreSQL et gestion de micro-services IO/Abonnement.
This commit is contained in:
Sepehr Ramezani
@@ -1,104 +1,69 @@
|
||||
# Memento - Google Keep Clone
|
||||
# Keep Notes ✨
|
||||
|
||||
A beautiful and feature-rich Google Keep clone built with modern web technologies.
|
||||
Keep Notes est une application avancée de prise de notes hybride, combinant la fluidité d'un outil local moderne avec la puissance de l'Intelligence Artificielle. Conçue pour offrir des performances maximales, elle utilise les dernières avancées de l'écosystème React et Next.js.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 🚀 Fonctionnalités
|
||||
|
||||
## ✨ Features
|
||||
- **Notes & Carnets** : Organisez vos idées rapidement avec des dossiers, codes couleurs, et épinglage.
|
||||
- **Support Markdown & Rendu Riche** : Éditez ou affichez vos notes instantanément.
|
||||
- **Disposition Masonry** : Grille CSS ultra-rapide (0 JavaScript) avec drag & drop fluide via `@dnd-kit`.
|
||||
- **Intégration de l'Intelligence Artificielle** :
|
||||
- **Memory Echo** : Suggestion automatique et connexions entre notes similaires (RAG / Embeddings).
|
||||
- **Auto-Tagging** : Création automatique d'étiquettes pertinentes.
|
||||
- **Organisation par lots** (Batch Organization) : Tri automatique des notes en vrac.
|
||||
- **Amélioration textuelle** : Reformulation, synthèse, ou traduction propulsés par l'IA.
|
||||
- **Haute Performance (RSC & Turbopack)** : Rendu Server Components natif pour une hydratation sans délai et développement accéléré via Turbopack.
|
||||
|
||||
- 📝 **Create & Edit Notes**: Quick note creation with expandable input
|
||||
- ☑️ **Checklist Support**: Create todo lists with checkable items
|
||||
- 🎨 **Color Customization**: 10 beautiful color themes for organizing notes
|
||||
- 📌 **Pin Notes**: Keep important notes at the top
|
||||
- 📦 **Archive**: Archive notes you want to keep but don't need to see
|
||||
- 🏷️ **Labels**: Organize notes with custom labels
|
||||
- 🔍 **Real-time Search**: Instantly search through all your notes
|
||||
- 🌓 **Dark Mode**: Beautiful dark theme with system preference detection
|
||||
- 📱 **Fully Responsive**: Works perfectly on desktop, tablet, and mobile
|
||||
- ⚡ **Server Actions**: Lightning-fast CRUD operations with Next.js 16
|
||||
- 🎯 **Type-Safe**: Full TypeScript support throughout
|
||||
## 📄 Licence et Droits d'Auteur
|
||||
|
||||
## 🚀 Tech Stack
|
||||
### **Licence Utilisateur Final (Version actuelle - Personnelle & Non-Commerciale)**
|
||||
Ce code source est fourni **strictement pour un usage personnel et éducatif**.
|
||||
- **Utilisation non-commerciale uniquement** : Il est interdit d'utiliser ce projet (ou tout code dérivé) pour générer des revenus, construire un produit commercial ou l'intégrer dans un service monétisé.
|
||||
- **Redistribution sous condition** : Vous ne pouvez pas redistribuer ou publier cette version sans maintenir cette licence restrictive.
|
||||
|
||||
### Frontend
|
||||
- **Next.js 16** - React framework with App Router
|
||||
- **TypeScript** - Type safety and better DX
|
||||
- **Tailwind CSS 4** - Utility-first CSS framework
|
||||
- **shadcn/ui** - Beautiful, accessible UI components
|
||||
- **Lucide React** - Modern icon library
|
||||
*(Inspiré de Creative Commons Attribution-NonCommercial 4.0 International - CC BY-NC 4.0).*
|
||||
|
||||
### Backend
|
||||
- **Next.js Server Actions** - Server-side mutations
|
||||
- **Prisma ORM** - Type-safe database client
|
||||
- **SQLite** - Lightweight database (easily switchable to PostgreSQL)
|
||||
---
|
||||
|
||||
## 📦 Installation
|
||||
## 🗺️ Roadmap & Version SaaS Commerciale Publique
|
||||
|
||||
### Prerequisites
|
||||
- Node.js 18+
|
||||
- npm or yarn
|
||||
Une version complète de **Keep Notes** destinée au grand public est prévue et en cours de planification. Cette version cloud s'appuiera sur de toutes nouvelles optimisations d'infrastructure :
|
||||
|
||||
### Steps
|
||||
1. **Migration Base de Données** :
|
||||
- Remplacement de SQLite local par **PostgreSQL** afin de supporter l'architecture multi-tenant (plusieurs utilisateurs avec sécurité accrue des données).
|
||||
2. **Système de Monétisation (Features IA)** :
|
||||
- Mise en place d'un modèle d'abonnement SaaS (Stripe).
|
||||
- Intégration d'un système de crédit ("AI Credits") pour réguler l'usage des API d'intelligence artificielle (LLMs, Embeddings) de façon soutenable.
|
||||
3. **Optimisations Scalabilité** :
|
||||
- Déploiement distribué.
|
||||
|
||||
1. **Clone the repository**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd keep-notes
|
||||
```
|
||||
---
|
||||
|
||||
2. **Install dependencies**
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
## 🛠️ Stack Technique
|
||||
|
||||
3. **Set up the database**
|
||||
```bash
|
||||
npx prisma generate
|
||||
npx prisma migrate dev
|
||||
```
|
||||
- **Framework** : Next.js 15 (App Router, Server Components)
|
||||
- **Frontend** : React 19, Tailwind CSS, Radix UI primitives
|
||||
- **Drag & Drop** : `@dnd-kit/core` & `sortable`
|
||||
- **Base de Données** : Prisma ORM, SQLite en env de développement (bientôt PostgreSQL)
|
||||
- **Outillage** : Turbopack, TypeScript
|
||||
|
||||
4. **Start the development server**
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
5. **Open your browser**
|
||||
Navigate to [http://localhost:3000](http://localhost:3000)
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
## 💻 Instructions de Développement
|
||||
|
||||
### Installation
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
npm install
|
||||
# ou
|
||||
yarn install
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
### Initialisation de la Base de données
|
||||
```bash
|
||||
npx prisma generate
|
||||
npx prisma db push
|
||||
```
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
||||
### Lancement du serveur (avec Turbopack)
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
Ouvrez [http://localhost:3000](http://localhost:3000) dans votre navigateur.
|
||||
|
||||
Reference in New Issue
Block a user