chore: clean up repo for public release
- Remove BMAD framework, IDE configs, dev screenshots, test files, internal docs, and backup files - Rename keep-notes/ to memento-note/ - Update all references from keep-notes to memento-note - Add Apache 2.0 license with Commons Clause (non-commercial restriction) - Add clean .gitignore and .env.docker.example
This commit is contained in:
18
README.md
18
README.md
@@ -21,7 +21,7 @@ Your support helps:
|
||||
|
||||
## 🚀 Project Location
|
||||
|
||||
The complete application is in the `keep-notes/` directory.
|
||||
The complete application is in the `memento-note/` directory.
|
||||
|
||||
## ✅ Completed Features
|
||||
|
||||
@@ -80,7 +80,7 @@ The complete application is in the `keep-notes/` directory.
|
||||
## 🏃 Quick Start
|
||||
|
||||
```bash
|
||||
cd keep-notes
|
||||
cd memento-note
|
||||
npm install
|
||||
npx prisma generate
|
||||
npx prisma migrate dev
|
||||
@@ -142,7 +142,7 @@ curl -X DELETE http://localhost:3000/api/notes/1
|
||||
### 6. MCP Server for AI Agents
|
||||
Start the MCP server for integration with Claude, N8N, or other MCP clients:
|
||||
```bash
|
||||
cd keep-notes
|
||||
cd memento-note
|
||||
npm run mcp
|
||||
```
|
||||
|
||||
@@ -169,7 +169,7 @@ Example N8N workflow available in: `n8n-memento-workflow.json`
|
||||
## 📂 Project Structure
|
||||
|
||||
```
|
||||
keep-notes/
|
||||
memento-note/
|
||||
├── app/
|
||||
│ ├── actions/notes.ts # Server actions (CRUD + images)
|
||||
│ ├── api/notes/ # REST API endpoints
|
||||
@@ -251,7 +251,7 @@ Keep Notes includes complete Docker configuration for easy deployment on Proxmox
|
||||
#### Quick Start
|
||||
|
||||
```bash
|
||||
cd keep-notes
|
||||
cd memento-note
|
||||
|
||||
# Create environment file
|
||||
cat > .env << EOF
|
||||
@@ -302,7 +302,7 @@ chmod +x deploy.sh
|
||||
#### Architecture
|
||||
|
||||
```
|
||||
keep-notes/
|
||||
memento-note/
|
||||
├── Dockerfile # Multi-stage build
|
||||
├── docker-compose.yml # Container orchestration
|
||||
├── .dockerignore # Build optimization
|
||||
@@ -334,7 +334,7 @@ OPENAI_API_KEY=sk-your-key-here
|
||||
|
||||
#### Documentation
|
||||
|
||||
See [DOCKER_DEPLOYMENT.md](keep-notes/DOCKER_DEPLOYMENT.md) for:
|
||||
See [DOCKER_DEPLOYMENT.md](memento-note/DOCKER_DEPLOYMENT.md) for:
|
||||
- Complete Proxmox deployment guide
|
||||
- SSL/HTTPS configuration with Let's Encrypt
|
||||
- Database backup and restore procedures
|
||||
@@ -347,7 +347,7 @@ See [DOCKER_DEPLOYMENT.md](keep-notes/DOCKER_DEPLOYMENT.md) for:
|
||||
For serverless deployment:
|
||||
|
||||
```bash
|
||||
cd keep-notes
|
||||
cd memento-note
|
||||
npm run build
|
||||
vercel deploy
|
||||
```
|
||||
@@ -357,7 +357,7 @@ vercel deploy
|
||||
For traditional VPS or bare metal:
|
||||
|
||||
```bash
|
||||
cd keep-notes
|
||||
cd memento-note
|
||||
npm install
|
||||
npx prisma generate
|
||||
npx prisma migrate deploy
|
||||
|
||||
Reference in New Issue
Block a user