Are you a first-timer in contributing to open source? These guidelines from GitHub might help!
-
Fork this repository.
-
Clone your forked repo to your machine.
git clone https://github.com/<your-username>/algorithm-visualizer.git
-
Choose whether to run
server
on your machine or to use the remote server.-
If you choose to run the server locally as well, follow the instructions here.
-
If you choose to use the remote server, temporarily (i.e., don't commit this change) modify
package.json
as follows:- "proxy": "http://localhost:8080", + "proxy": "https://algorithm-visualizer.org",
-
-
Install dependencies, and run the web app.
cd algorithm-visualizer npm install npm start
-
Open
http://localhost:3000/
in a web browser.
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.