Skip to content

shadowmkj/rumbly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rumbly (Run Assembly) NASM Assembly Execution Web Platform

Rumbly Banner

Build Status License: MIT GitHub stars GitHub forks

Rumbly is a powerful and intuitive web-based platform for writing, executing, and testing NASM (Netwide Assembler) assembly code right from your browser. It leverages a robust backend built with Express.js and isolates code execution within secure Docker containers, providing a safe and reliable environment for running assembly programs. The frontend is a modern and responsive application built with React and Vite.


Features

  • Online NASM Editor: A feature-rich code editor with syntax highlighting for assembly language.
  • Real-time Execution: Instantly execute your NASM code and see the output.
  • Secure Environment: Code execution is sandboxed in Docker containers to prevent any harm to the host system.
  • User-friendly Interface: A clean, intuitive, and responsive UI built with React and Vite.
  • API-driven: A well-defined Express.js API to manage code compilation and execution.
  • Easy to Set Up: Get the entire platform running locally with just a few commands.

Tech Stack


Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js (v14 or later)
  • npm or yarn
  • Docker and Docker Compose

Installation

  1. Clone the repository:

    git clone [https://github.com/IamShaDoW666/rumbly.git](https://github.com/IamShaDoW666/rumbly.git)
    cd rumbly
  2. Install frontend dependencies:

    cd frontend
    npm install
  3. Install backend dependencies:

    cd ../api
    npm install
  4. Set up environment variables:

    Create a .env file in the api directory and add the following variables:

    PORT=3000

Usage

  1. Start the Docker containers:

    Make sure Docker is running on your machine. Then, from the root of the project, run:

    docker-compose up --build
  2. Start the frontend development server:

    cd frontend
    npm run dev
  3. Start the backend server:

    cd api
    npm start
  4. Open your browser and navigate to http://localhost:5173 (or the port Vite assigns).

Now you can write your NASM code in the editor and click the "Run" button to see the output.


Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.


About

A platform to run NASM code

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •