Contributing

Table of Contents

Running Locally

Running in Gitpod

Directory Structure

Are you a first-timer in contributing to open source? These guidelines from GitHub might help!

Running Locally

Clone your forked repo to your machine.

git clone https://github.com/<your-username>/algorithm-visualizer.git

Install dependencies, and run the web app.

cd algorithm-visualizer

npm install

npm start

You can also run algorithm-visualizer in Gitpod, a free online dev environment for GitHub.

branding/ contains representative image files.
public/ contains static files to be served.
src/ contains source code.
- apis/ defines outgoing API requests.
- common/ contains commonly used files.
- components/ contains UI components.
- core/ processes visualization.
  - layouts/ layout tracers.
  - renderers/ renders visualization data.
  - tracers/ interprets visualizing commands into visualization data.
- files/ contains markdown or skeleton files to be shown in the code editor.
- reducers/ contains Redux reducers.