Skip to content

Commit d674f2d

Browse files
author
Raffael Herrmann
committed
Add comprehensive README with installation guide and project info
1 parent 37ed8fb commit d674f2d

1 file changed

Lines changed: 81 additions & 0 deletions

File tree

README.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# MassCode Web
2+
3+
A modern web interface for browsing and searching your MassCode snippets with syntax highlighting, themes, and copy-to-clipboard functionality.
4+
5+
![MassCode Web](https://img.shields.io/badge/MassCode-Web-blue?style=for-the-badge&logo=docker)
6+
![Docker](https://img.shields.io/badge/Docker-Ready-green?style=flat-square&logo=docker)
7+
![License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)
8+
9+
## ✨ Features
10+
11+
- 🔍 **Search & Filter**: Quickly find snippets by name, description, or content
12+
- 🎨 **Themes**: Light, dark, and auto themes with smooth transitions
13+
- 📋 **Copy to Clipboard**: One-click copying of code blocks with visual feedback
14+
- 🌳 **Tree Navigation**: Browse snippets organized in folders
15+
- 📱 **Responsive Design**: Works on desktop and mobile devices
16+
- 🐳 **Docker Ready**: Easy deployment with Docker Compose
17+
18+
## 🚀 Quick Start
19+
20+
### Using Docker Compose (Recommended)
21+
22+
1. **Clone the repository**:
23+
```bash
24+
git clone https://github.com/codebude/masscode-web.git
25+
cd masscode-web
26+
```
27+
28+
2. **Place your data**:
29+
```bash
30+
# Copy your MassCode db.json file to the project root
31+
cp /path/to/your/masscode/db.json ./db.json
32+
```
33+
34+
3. **Run with Docker Compose**:
35+
```bash
36+
docker-compose up -d
37+
```
38+
39+
4. **Open your browser**:
40+
```
41+
http://localhost:8080
42+
```
43+
44+
### Volume Mapping
45+
46+
The `docker-compose.yml` includes a volume mount that maps your local `db.json` file to the container:
47+
48+
```yaml
49+
volumes:
50+
- ./db.json:/usr/share/nginx/html/data/db.json:ro
51+
```
52+
53+
This allows you to:
54+
- Keep your data file outside the container
55+
- Update snippets without rebuilding the image
56+
- Maintain data persistence
57+
58+
### Manual Docker Run
59+
60+
```bash
61+
docker run -d -p 8080:80 -v $(pwd)/db.json:/usr/share/nginx/html/data/db.json:ro ghcr.io/codebude/masscode-web:latest
62+
```
63+
64+
## 🎯 What is MassCode?
65+
66+
This project is a web frontend for [MassCode](https://masscode.io/), the ultimate code snippet manager for developers. MassCode is a free and open-source code snippets manager, built with Electron & Vue.js.
67+
68+
## 🤝 Contributing
69+
70+
Found a bug or have a feature request? Feel free to:
71+
- [Open an issue](https://github.com/codebude/masscode-web/issues)
72+
- [Create a pull request](https://github.com/codebude/masscode-web/pulls)
73+
- ⭐ Star the repository if you find it useful!
74+
75+
## 📄 License
76+
77+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
78+
79+
---
80+
81+
**Try MassCode Web today and supercharge your snippet management! 🚀**

0 commit comments

Comments
 (0)