Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/husseinhareb/coffee
Text editor with file management and terminal integration using Electron.
https://github.com/husseinhareb/coffee
Last synced: about 14 hours ago
JSON representation
Text editor with file management and terminal integration using Electron.
- Host: GitHub
- URL: https://github.com/husseinhareb/coffee
- Owner: husseinhareb
- License: mit
- Created: 2023-11-24T19:09:51.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-04-07T11:16:48.000Z (8 months ago)
- Last Synced: 2024-04-07T12:24:41.821Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 3.3 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Coffee is a text editor built using Electron, offering file management and integrated terminal functionality.
Oriented for developers, Coffee provides a user-friendly solution for text editing.
## File Management
Coffee provides comprehensive file management functionalities to streamline your workflow:
- **New File:** Create a new text file effortlessly with the option available in the File menu.
- **New Folder:** Organize your files by creating new folders directly from the interface.
- **Open Directory:** Navigate to and open directories to access and manage files and folders within them.
- **Delete:** Remove unwanted files or folders securely with the delete function.
- **Rename:** Easily rename files or folders to maintain a structured file hierarchy.
- **Navigate:** Seamlessly move between directories, including returning to parent directories or entering new ones.
## Text Editing with Ace Editor
Coffee utilizes the powerful Ace editor to provide a rich and text editing experience. Ace editor is renowned for its exceptional syntax highlighting, live error detection
-**Syntax Highlighting:** Enjoy comprehensive syntax highlighting support for a wide range of programming languages and file types, ensuring code clarity and readability.
-**Live Error Detection:** Benefit from real-time error and warning detection as you type, allowing for immediate identification and correction of syntax errors and potential bugs.
-**Code Folding:** Collapse and expand code blocks effortlessly to focus on specific sections of your codebase, improving navigation and readability.
## Integrated Terminal with xterm.js
Coffee features a fully integrated terminal powered by xterm.js,
offering a robust command-line interface directly within the text editor environment,
comparable to standalone terminal emulators like Kitty or Alacritty,
allowing users to execute commands, run scripts, and perform system tasks without leaving the editor.
### Getting Started
Follow these steps to run the app locally:
1. **Clone the repository**:
```
git clone https://github.com/husseinhareb/Coffee
```
2. **Install dependencies**:
```
cd Coffee/
npm install
```
3. **Rebuild the application**(One time thing):
```
npm run rebuild
```
4. **Run the application**:
```
npm start
```
## Contributing
Contributions are welcome! If you'd like to contribute:
Fork the repository.
Create your branch: git checkout -b feature/YourFeature.
Commit your changes: git commit -m 'Add some feature'.
Push to the branch: git push origin feature/YourFeature.
Submit a pull request.
## Licence
This project is licensed under the [MIT License](https://github.com/husseinhareb/Coffee/blob/master/LICENSE).