Move folder structure into its own file

This commit is contained in:
Kristofer Selbekk
2018-10-07 18:48:49 +02:00
parent 196fa46d1d
commit c5590b72f3
4 changed files with 48 additions and 40 deletions

View File

@@ -0,0 +1,39 @@
---
id: folder-structure
title: Folder structure
---
After creation, your project should look like this:
```
my-app/
README.md
node_modules/
package.json
public/
index.html
favicon.ico
src/
App.css
App.js
App.test.js
index.css
index.js
logo.svg
```
For the project to build, **these files must exist with exact filenames**:
- `public/index.html` is the page template;
- `src/index.js` is the JavaScript entry point.
You can delete or rename the other files.
You may create subdirectories inside `src`. For faster rebuilds, only files inside `src` are processed by Webpack.<br>
You need to **put any JS and CSS files inside `src`**, otherwise Webpack wont see them.
Only files inside `public` can be used from `public/index.html`.<br>
Read instructions below for using assets from JavaScript and HTML.
You can, however, create more top-level directories.<br>
They will not be included in the production build so you can use them for things like documentation.

View File

@@ -12,7 +12,6 @@ You can find the most recent version of this guide [here](https://github.com/fac
## Table of Contents
- [Updating to New Releases](#updating-to-new-releases)
- [Folder Structure](#folder-structure)
- [Supported Browsers](#supported-browsers)
- [Supported Language Features](#supported-language-features)
- [Syntax Highlighting in the Editor](#syntax-highlighting-in-the-editor)
@@ -83,43 +82,6 @@ In most cases bumping the `react-scripts` version in `package.json` and running
We commit to keeping the breaking changes minimal so you can upgrade `react-scripts` painlessly.
## Folder Structure
After creation, your project should look like this:
```
my-app/
README.md
node_modules/
package.json
public/
index.html
favicon.ico
src/
App.css
App.js
App.test.js
index.css
index.js
logo.svg
```
For the project to build, **these files must exist with exact filenames**:
- `public/index.html` is the page template;
- `src/index.js` is the JavaScript entry point.
You can delete or rename the other files.
You may create subdirectories inside `src`. For faster rebuilds, only files inside `src` are processed by Webpack.<br>
You need to **put any JS and CSS files inside `src`**, otherwise Webpack wont see them.
Only files inside `public` can be used from `public/index.html`.<br>
Read instructions below for using assets from JavaScript and HTML.
You can, however, create more top-level directories.<br>
They will not be included in the production build so you can use them for things like documentation.
## Available Scripts
In the project directory, you can run:

View File

@@ -32,6 +32,14 @@
"title": "Running Tests",
"sidebar_label": "Running tests"
},
"sending-feedback": {
"title": "Sending feedback",
"sidebar_label": "Feedback"
},
"something-missing": {
"title": "Something missing?",
"sidebar_label": "Something missing?"
},
"troubleshooting": {
"title": "Troubleshooting",
"sidebar_label": "Troubleshooting"

View File

@@ -1,7 +1,6 @@
{
"docs": {
"Getting Started": ["getting-started"],
"User Guide": ["user-guide", "available-scripts"],
"Getting Started": ["getting-started", "folder-structure", "available-scripts"],
"Testing": ["running-tests", "debugging-tests"],
"Deployment": ["publishing-components-to-npm", "deployment"],
"Support": ["troubleshooting", "sending-feedback", "something-missing"]