https://github.com/shiftyx1/sourcepad
Simple code editor built with Monaco
https://github.com/shiftyx1/sourcepad
code editor ide
Last synced: 5 months ago
JSON representation
Simple code editor built with Monaco
- Host: GitHub
- URL: https://github.com/shiftyx1/sourcepad
- Owner: ShiftyX1
- License: mit
- Created: 2025-08-19T22:04:48.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-08-19T23:48:01.000Z (5 months ago)
- Last Synced: 2025-08-19T23:59:47.700Z (5 months ago)
- Topics: code, editor, ide
- Language: JavaScript
- Homepage:
- Size: 76.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shifty's SourcePad
Simple code editor built with Monaco Editor and Electron + TypeScript/Vite.
[](https://github.com/ShiftyX1/sourcepad/releases)
[](https://github.com/ShiftyX1/sourcepad/releases)
[](https://github.com/ShiftyX1/sourcepad/actions)
[](https://github.com/ShiftyX1/sourcepad/blob/master/LICENSE)
[](https://github.com/ShiftyX1/sourcepad/commits/master)
[](https://www.electronjs.org/)
[](https://nodejs.org/)
## Download
Download the latest version from [Releases](https://github.com/ShiftyX1/sourcepad/releases):
- **Windows**: `SourcePad-Setup.exe` or `SourcePad-win.exe` (portable)
- **macOS**: `SourcePad.dmg` or `SourcePad-mac.zip`
- **Linux**: `SourcePad.AppImage`, `.deb`, or `.rpm`
## Quick Start
### For Users:
1. Download and install SourcePad for your platform
2. Launch the application
3. Create a new file or open an existing one
4. Start coding with full syntax highlighting and intellisense!
### For Developers:
```bash
git clone https://github.com/yourusername/sourcepad.git
cd sourcepad
# Install dependencies
pnpm install
# Start development
pnpm run dev:full
```
## Development
### Prerequisites
- Node.js v22.16.0
- pnpm or yarn
### Setup
```bash
pnpm install # Install all dependencies
pnpm run dev:full # Start in development mode
```
### Building for Production
```bash
# Build for all platforms
pnpm run build
# Build for specific platform
pnpm run build:win # Windows
pnpm run build:mac # macOS
pnpm run build:linux # Linux
```
## Project Structure
```
sourcepad/
├── src/
│ ├── main/ # Backend Electron logic and app entrypoint
│ │ ├── main.ts
│ │ └── preload.ts
│ └── renderer/ # Frontend components and logic
│ ├── editor/
│ ├── start-page/
│ ├── types/
│ └── vite-env.d.ts
├── scripts/ # Build scripts
│ ├── setup-monaco.js # Monaco setup (Legacy, will be removed)
│ └── kill-processes.sh # Helper script
└── assets/ # App icons and resources
```
## Contributing
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## Release Process
### Automatic Releases
- **Push to master** → Creates nightly build
- **Create tag `v1.0.0`** → Creates stable release
### Manual Release
```bash
# Create and push a tag
git tag v1.0.0
git push origin v1.0.0
# GitHub Actions will automatically:
# 1. Build for all platforms
# 2. Create release with binaries
# 3. Generate changelog
```
## Configuration
### electron-builder
See `package.json` build section for packaging configuration.
### GitHub Actions
Automated building and releasing via `.github/workflows/build.yml`.
## Roadmap
- [ ] **File Explorer** - Sidebar with file tree
- [ ] **Multi-tab editing** - Open multiple files
- [ ] **Find & Replace** - Search functionality
- [ ] **Extensions** - Plugin system
- [ ] **Git integration** - Basic git operations
- [ ] **Terminal** - Integrated terminal
- [ ] **Language servers** - Enhanced intellisense for more languages
- [ ] **Auto-updates** - Automatic application updates
## Bug Reports
Found a bug? Please [create an issue](https://github.com/ShiftyX1/sourcepad/issues) with:
- Operating system and version
- Steps to reproduce
- Expected vs actual behavior
- Screenshots (if applicable)
## License
MIT License - see [LICENSE](LICENSE) file for details.
## Acknowledgments
- [Monaco Editor](https://microsoft.github.io/monaco-editor/) - Microsoft's JavaScript code editor
- [Electron](https://electronjs.org/) - Framework for desktop apps
- [electron-builder](https://electron.build/) - Packaging and distribution