https://github.com/mastashake08/shake-editor-mvp
A sample project aiming to create a simple Javascript code editor in the browser.
https://github.com/mastashake08/shake-editor-mvp
code-editor-online javascript
Last synced: 5 months ago
JSON representation
A sample project aiming to create a simple Javascript code editor in the browser.
- Host: GitHub
- URL: https://github.com/mastashake08/shake-editor-mvp
- Owner: mastashake08
- License: mit
- Created: 2024-01-13T06:21:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-13T07:03:22.000Z (about 2 years ago)
- Last Synced: 2025-06-20T06:07:26.709Z (9 months ago)
- Topics: code-editor-online, javascript
- Language: JavaScript
- Homepage: https://editor.jcompsolu.com/
- Size: 35.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
Sure, here's a draft of the user manual for our new JavaScript code editor application:
# JavaScript Code Editor
A web-based application that allows you to write, run, load, and save JavaScript code. Styled with the Tailwind CSS library and containerized with Docker for easy deployment and scalability.
## Main Features
- **Code Editor**: A text field where you can write your JavaScript code.
- **Run Button**: Executes the JavaScript code written in the text field.
- **Load Button**: Allows you to load a JavaScript file into the text field.
- **Save Button**: Saves the content of the text field as a JavaScript file.
## Installation
### Prerequisites
- Docker installed on your machine.
- Git installed on your machine.
- A GitHub account.
### Steps
1. Clone the repository from GitHub.
```
git clone https://github.com/mastashake08/JavaScript-Code-Editor.git
```
2. Navigate into the project directory.
```
cd JavaScript-Code-Editor
```
3. Build the Docker image.
```
docker build -t js-code-editor .
```
4. Run the Docker container.
```
docker run -p 80:80 js-code-editor
```
5. Open your web browser and navigate to `http://localhost`.
## Usage
1. Write your JavaScript code in the text field.
2. Click the "Run" button to execute your code. Any console output will be displayed in your browser's console.
3. Click the "Load" button to load a JavaScript file into the text field. Select the file you want to load from the file dialog.
4. Click the "Save" button to save the content of the text field as a JavaScript file. The file will be downloaded to your default download location.
## GitHub Action
The repository includes a GitHub action that deploys the application to GitHub Pages whenever you push to the master branch. To use this action, you need to set up a GitHub Pages repository and add your `GITHUB_TOKEN` to your repository's secrets.
## Support
If you encounter any issues or have any questions, please open an issue on our GitHub repository. We're here to help!
Please note that this application is intended for educational and development purposes and should not be used to execute untrusted code.