|
2 | 2 |
|
3 | 3 | > #### Table of Contents |
4 | 4 | > - [Running Locally](#running-locally) |
5 | | -> - [Creating a Pull Request](#creating-a-pull-request) |
| 5 | +> - [Directory Structure](#directory-structure) |
| 6 | +
|
| 7 | +Are you a first-timer in contributing to open source? [These guidelines](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) from GitHub might help! |
6 | 8 |
|
7 | 9 | ## Running Locally |
8 | 10 |
|
|
14 | 16 | git clone https://github.com/<your-username>/algorithm-visualizer.git |
15 | 17 | ``` |
16 | 18 |
|
17 | | -3. Install [Docker](https://docs.docker.com/install/), if not already installed. |
18 | | - |
19 | | -4. Install dependencies, and run the server. |
| 19 | +3. Install dependencies, and run the web app. |
20 | 20 |
|
21 | 21 | ```bash |
22 | 22 | cd algorithm-visualizer |
23 | 23 |
|
24 | 24 | npm install |
25 | 25 | |
26 | | - npm run dev |
27 | | - ``` |
28 | | - |
29 | | -5. Open [`http://localhost:8080/`](http://localhost:8080/) in a web browser. |
30 | | - |
31 | | -## Creating a Pull Request |
32 | | - |
33 | | -6. Create a branch addressing the issue/improvement you'd like to tackle. |
34 | | -
|
35 | | - ```bash |
36 | | - git checkout -b my-problem-fixer-branch |
| 26 | + npm start |
37 | 27 | ``` |
38 | | -
|
39 | | -7. Write some awesome code. |
40 | | -
|
41 | | -8. Commit the changes, and push them to `my-problem-fixer-branch` branch on your forked repo. |
42 | | -
|
43 | | - ```bash |
44 | | - git add . |
45 | 28 |
|
46 | | - git commit -m "Explain my awesome changes" |
47 | | -
|
48 | | - git push origin my-problem-fixer-branch |
49 | | - ``` |
50 | | -
|
51 | | -9. Create a pull request from `my-problem-fixer-branch` branch on your forked repo to `master` branch on the main repo. |
| 29 | +4. Open [`http://localhost:3000/`](http://localhost:3000/) in a web browser. |
| 30 | + |
| 31 | +## Directory Structure |
| 32 | + |
| 33 | +- [**branding/**](branding) contains representative image files. |
| 34 | +- [**public/**](public) contains static files to be served. |
| 35 | +- [**src/**](src) contains source code. |
| 36 | + - [**apis/**](src/apis) defines outgoing API requests. |
| 37 | + - [**common/**](src/common) contains commonly used files. |
| 38 | + - [**components/**](src/components) contains UI components. |
| 39 | + - [**core/**](src/core) processes visualization. |
| 40 | + - [**layouts/**](src/core/layouts) layout tracers. |
| 41 | + - [**renderers/**](src/core/renderers) renders visualization data. |
| 42 | + - [**tracers/**](src/core/tracers) interprets visualizing commands into visualization data. |
| 43 | + - [**files/**](src/files) contains markdown or skeleton files to be shown in the code editor. |
| 44 | + - [**reducers/**](src/reducers) contains Redux reducers. |
0 commit comments