Skip to content

Commit

Permalink
Merge pull request #35 from NMFS-RADFish/RADFISH-258-explain-each-folder
Browse files Browse the repository at this point in the history
RADFISH-258: Explain folder structure
  • Loading branch information
IsaiahHarris authored Aug 26, 2024
2 parents e527186 + 72317c7 commit c389ec4
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ Then open [http://localhost:3000/](http://localhost:3000/) to see your app.

**Option 2:** If you would like to scaffold from 1 example, please see [Running an Example](./building-your-application/available-scripts/running-example.md)

**Option 3:** You can also clone the [boilerplate repo](https://github.com/NMFS-RADFish/boilerplate) to get all the examples.
**Option 3:** You can also clone the [boilerplate repo](https://github.com/NMFS-RADFish/boilerplate) to get all the examples.

Then:

```bash
cd boilerplate/examples/[example you want to run]
npm i
Expand Down Expand Up @@ -81,6 +82,28 @@ my-app
└── setupTests.js
```

## Folder Structure Explanation

### `node_modules/`

This directory contains all the project's dependencies installed via npm. It's automatically generated when you run `npm install`. You should not manually modify this folder, as it's managed by npm.

### `public/`

The `public` folder contains static assets that will be served directly to the browser. These files are not processed by Webpack. Common files in this folder include the main `index.html` file, favicon, and other public resources like images and manifest files.

- **`index.html`**: The main HTML file that serves as the entry point for your React application.
- **`favicon.ico`**: The small icon that appears in the browser tab next to the title of the page.
- **`manifest.json`**: Provides metadata about the web application, useful for Progressive Web Apps (PWAs).

### `src/`

The `src` folder is where all the source code for your React application resides. This is where you will spend most of your development time.

- **`App.js`**: The main component of your React application, typically serving as the entry point for your app's component hierarchy.
- **`components/`**: This folder contains reusable React components that can be used throughout the application.
- **`assets/`**: A directory for storing images, fonts, and other static media assets used in the application.

# Scripts

## `npm start`
Expand Down

0 comments on commit c389ec4

Please sign in to comment.