Skip to content
Jacques Artale edited this page Feb 18, 2024 · 6 revisions

Project Overview

Introduction

Welcome to the Code-Vis Wiki, your go-to resource for everything about the project. Code-Vis is an interactive JavaScript Code Visualizer designed to aid developers in understanding JavaScript code execution through visualization. By interpreting JavaScript code, it can visually represent the code's behavior step by step.

Live Demo

Experience Code-Vis in action at the live demo: https://www.code-vis.io/.

Prerequisites

Before diving into Code-Vis, ensure you have:

  • The latest version of Node.js installed
  • The latest version of npm installed
  • A Linux machine (Windows/macOS not officially supported)
  • Docker installed (Optional but recommended)

Installation Guide

  1. Clone the repository:
git clone https://github.com/jacques-artale/code-vis.git
  1. Navigate to the project directory:
cd code-vis/
  1. Install dependencies:
npm install

Usage

Development

Start the app in development mode:

npm run dev

Access it at http://localhost:8080/.

Production

Build the app for production using Webpack:

npm run build

Run the app in production mode:

npm run start

Access it at http://localhost:3000/.

Docker

Build a Docker image:

npm run docker:build

Run a container from the image:

npm run docker:run

Access it at http://localhost:3000/.

Testing

Run tests using Jest:

npm run test

Contributing

Contributions are welcome! Whether it's through submitting bugs, writing documentation, or proposing new features, your help is appreciated in making Code-Vis a powerful tool for developers. Just fork the repository and create a pull request.

Support

Encountered a problem? Submit an issue on the GitHub repository!