|
1 | | -# Create React App [](https://dev.azure.com/facebook/create-react-app/_build/latest?definitionId=1&branchName=master) [](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md) |
| 1 | +# Pelago Create React App |
2 | 2 |
|
3 | | -Create React apps with no build configuration. |
| 3 | +This is a fork of the actual [Create React App](https://create-react-app.dev/) aimed at providing the necessary flexibility needed without losing support from CRA by ejecting it or using wrappers that internally eject CRA like [customize-cra](https://github.com/arackaf/customize-cra) |
4 | 4 |
|
5 | | -- [Creating an App](#creating-an-app) – How to create a new app. |
6 | | -- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App. |
7 | | - |
8 | | -Create React App works on macOS, Windows, and Linux.<br> |
9 | | -If something doesn’t work, please [file an issue](https://github.com/facebook/create-react-app/issues/new).<br> |
10 | | -If you have questions or need help, please ask in our [Spectrum](https://spectrum.chat/create-react-app) community. |
| 5 | +Currently the app is forked off the `create-react-app v3.4.1` |
11 | 6 |
|
12 | 7 | ## Quick Overview |
13 | 8 |
|
14 | | -```sh |
15 | | -npx create-react-app my-app |
16 | | -cd my-app |
17 | | -npm start |
18 | | -``` |
19 | | - |
20 | | -If you've previously installed `create-react-app` globally via `npm install -g create-react-app`, we recommend you uninstall the package using `npm uninstall -g create-react-app` to ensure that npx always uses the latest version. |
21 | | - |
22 | | -_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_ |
23 | | - |
24 | | -Then open [http://localhost:3000/](http://localhost:3000/) to see your app.<br> |
25 | | -When you’re ready to deploy to production, create a minified bundle with `npm run build`. |
26 | | - |
27 | | -<p align='center'> |
28 | | -<img src='https://cdn.jsdelivr.net/gh/facebook/create-react-app@27b42ac7efa018f2541153ab30d63180f5fa39e0/screencast.svg' width='600' alt='npm start'> |
29 | | -</p> |
30 | | - |
31 | | -### Get Started Immediately |
32 | | - |
33 | | -You **don’t** need to install or configure tools like webpack or Babel.<br> |
34 | | -They are preconfigured and hidden so that you can focus on the code. |
35 | | - |
36 | | -Create a project, and you’re good to go. |
37 | | - |
38 | | -## Creating an App |
39 | | - |
40 | | -**You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine** (but it’s not required on the server). You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to switch Node versions between different projects. |
41 | | - |
42 | | -To create a new app, you may choose one of the following methods: |
43 | | - |
44 | | -### npx |
45 | | - |
46 | | -```sh |
47 | | -npx create-react-app my-app |
48 | | -``` |
49 | | - |
50 | | -_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) is a package runner tool that comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_ |
51 | | - |
52 | | -### npm |
53 | | - |
54 | | -```sh |
55 | | -npm init react-app my-app |
56 | | -``` |
57 | | - |
58 | | -_`npm init <initializer>` is available in npm 6+_ |
59 | | - |
60 | | -### Yarn |
61 | | - |
62 | | -```sh |
63 | | -yarn create react-app my-app |
64 | | -``` |
65 | | - |
66 | | -_[`yarn create <starter-kit-package>`](https://yarnpkg.com/lang/en/docs/cli/create/) is available in Yarn 0.25+_ |
67 | | - |
68 | | -It will create a directory called `my-app` inside the current folder.<br> |
69 | | -Inside that directory, it will generate the initial project structure and install the transitive dependencies: |
70 | | - |
71 | | -``` |
72 | | -my-app |
73 | | -├── README.md |
74 | | -├── node_modules |
75 | | -├── package.json |
76 | | -├── .gitignore |
77 | | -├── public |
78 | | -│ ├── favicon.ico |
79 | | -│ ├── index.html |
80 | | -│ └── manifest.json |
81 | | -└── src |
82 | | - ├── App.css |
83 | | - ├── App.js |
84 | | - ├── App.test.js |
85 | | - ├── index.css |
86 | | - ├── index.js |
87 | | - ├── logo.svg |
88 | | - └── serviceWorker.js |
89 | | -``` |
90 | | - |
91 | | -No configuration or complicated folder structures, only the files you need to build your app.<br> |
92 | | -Once the installation is done, you can open your project folder: |
93 | | - |
94 | | -```sh |
95 | | -cd my-app |
96 | | -``` |
97 | | - |
98 | | -Inside the newly created project, you can run some built-in commands: |
99 | | - |
100 | | -### `npm start` or `yarn start` |
101 | | - |
102 | | -Runs the app in development mode.<br> |
103 | | -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
104 | | - |
105 | | -The page will automatically reload if you make changes to the code.<br> |
106 | | -You will see the build errors and lint warnings in the console. |
107 | | - |
108 | | -<p align='center'> |
109 | | -<img src='https://cdn.jsdelivr.net/gh/marionebl/create-react-app@9f6282671c54f0874afd37a72f6689727b562498/screencast-error.svg' width='600' alt='Build errors'> |
110 | | -</p> |
111 | | - |
112 | | -### `npm test` or `yarn test` |
113 | | - |
114 | | -Runs the test watcher in an interactive mode.<br> |
115 | | -By default, runs tests related to files changed since the last commit. |
116 | | - |
117 | | -[Read more about testing.](https://facebook.github.io/create-react-app/docs/running-tests) |
118 | | - |
119 | | -### `npm run build` or `yarn build` |
120 | | - |
121 | | -Builds the app for production to the `build` folder.<br> |
122 | | -It correctly bundles React in production mode and optimizes the build for the best performance. |
123 | | - |
124 | | -The build is minified and the filenames include the hashes.<br> |
125 | | - |
126 | | -Your app is ready to be deployed. |
127 | | - |
128 | | -## User Guide |
129 | | - |
130 | | -You can find detailed instructions on using Create React App and many tips in [its documentation](https://facebook.github.io/create-react-app/). |
131 | | - |
132 | | -## How to Update to New Versions? |
133 | | - |
134 | | -Please refer to the [User Guide](https://facebook.github.io/create-react-app/docs/updating-to-new-releases) for this and other information. |
135 | | - |
136 | | -## Philosophy |
137 | | - |
138 | | -- **One Dependency:** There is only one build dependency. It uses webpack, Babel, ESLint, and other amazing projects, but provides a cohesive curated experience on top of them. |
139 | | - |
140 | | -- **No Configuration Required:** You don't need to configure anything. A reasonably good configuration of both development and production builds is handled for you so you can focus on writing code. |
141 | | - |
142 | | -- **No Lock-In:** You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off. |
143 | | - |
144 | | -## What’s Included? |
145 | | - |
146 | | -Your environment will have everything you need to build a modern single-page React app: |
147 | | - |
148 | | -- React, JSX, ES6, TypeScript and Flow syntax support. |
149 | | -- Language extras beyond ES6 like the object spread operator. |
150 | | -- Autoprefixed CSS, so you don’t need `-webkit-` or other prefixes. |
151 | | -- A fast interactive unit test runner with built-in support for coverage reporting. |
152 | | -- A live development server that warns about common mistakes. |
153 | | -- A build script to bundle JS, CSS, and images for production, with hashes and sourcemaps. |
154 | | -- An offline-first [service worker ](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers) and a [web app manifest ](https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/), meeting all the [Progressive Web App ](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) criteria. ( _Note: Using the service worker is opt-in as of `[email protected]` and higher _) |
155 | | -- Hassle-free updates for the above tools with a single dependency. |
156 | | - |
157 | | -Check out [this guide](https://github.com/nitishdayal/cra_closer_look) for an overview of how these tools fit together. |
158 | | - |
159 | | -The tradeoff is that **these tools are preconfigured to work in a specific way**. If your project needs more customization, you can ["eject"](https://facebook.github.io/create-react-app/docs/available-scripts#npm-run-eject) and customize it, but then you will need to maintain this configuration. |
160 | | - |
161 | | -## Popular Alternatives |
162 | | - |
163 | | -Create React App is a great fit for: |
164 | | - |
165 | | -- **Learning React** in a comfortable and feature-rich development environment. |
166 | | -- **Starting new single-page React applications.** |
167 | | -- **Creating examples** with React for your libraries and components. |
168 | | - |
169 | | -Here are a few common cases where you might want to try something else: |
170 | | - |
171 | | -- If you want to **try React** without hundreds of transitive build tool dependencies, consider [using a single HTML file or an online sandbox instead](https://reactjs.org/docs/try-react.html). |
172 | | - |
173 | | -- If you need to **integrate React code with a server-side template framework** like Rails, Django or Symfony, or if you’re **not building a single-page app**, consider using [nwb](https://github.com/insin/nwb), or [Neutrino](https://neutrino.js.org/) which are more flexible. For Rails specifically, you can use [Rails Webpacker](https://github.com/rails/webpacker). For Symfony, try [Symfony's webpack Encore](https://symfony.com/doc/current/frontend/encore/reactjs.html). |
174 | | - |
175 | | -- If you need to **publish a React component**, [nwb](https://github.com/insin/nwb) can [also do this](https://github.com/insin/nwb#react-components-and-libraries), as well as [Neutrino's react-components preset](https://neutrino.js.org/packages/react-components/). |
176 | | - |
177 | | -- If you want to do **server rendering** with React and Node.js, check out [Next.js](https://github.com/zeit/next.js/) or [Razzle](https://github.com/jaredpalmer/razzle). Create React App is agnostic of the backend, and only produces static HTML/JS/CSS bundles. |
178 | | - |
179 | | -- If your website is **mostly static** (for example, a portfolio or a blog), consider using [Gatsby](https://www.gatsbyjs.org/) instead. Unlike Create React App, it pre-renders the website into HTML at the build time. |
180 | | - |
181 | | -- Finally, if you need **more customization**, check out [Neutrino](https://neutrino.js.org/) and its [React preset](https://neutrino.js.org/packages/react/). |
182 | | - |
183 | | -All of the above tools can work with little to no configuration. |
184 | | - |
185 | | -If you prefer configuring the build yourself, [follow this guide](https://reactjs.org/docs/add-react-to-an-existing-app.html). |
186 | | - |
187 | | -## React Native |
188 | | - |
189 | | -Looking for something similar, but for React Native?<br> |
190 | | -Check out [Expo CLI](https://github.com/expo/expo-cli). |
191 | | - |
192 | | -## Contributing |
193 | | - |
194 | | -We'd love to have your helping hand on `create-react-app`! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started. |
195 | | - |
196 | | -## Credits |
197 | | - |
198 | | -This project exists thanks to all the people who [contribute](CONTRIBUTING.md).<br> |
199 | | -<a href="https://github.com/facebook/create-react-app/graphs/contributors"><img src="https://opencollective.com/create-react-app/contributors.svg?width=890&button=false" /></a> |
200 | | - |
201 | | -Thanks to [Netlify](https://www.netlify.com/) for hosting our documentation. |
202 | | - |
203 | | -## Acknowledgements |
204 | | - |
205 | | -We are grateful to the authors of existing related projects for their ideas and collaboration: |
206 | | - |
207 | | -- [@eanplatter](https://github.com/eanplatter) |
208 | | -- [@insin](https://github.com/insin) |
209 | | -- [@mxstbr](https://github.com/mxstbr) |
210 | | - |
211 | | -## License |
| 9 | +This fork is primarily aimed at exposing one specific package in the repo - `react-scripts`. In future we may go the route of just forking `react-scripts` as a git submodule or a similar approach if there is a clear way to keep updated with the original repo. |
212 | 10 |
|
213 | | -Create React App is open source software [licensed as MIT](https://github.com/facebook/create-react-app/blob/master/LICENSE). |
| 11 | +Please head to `packages/react-scripts/README.md` to know more about the setup, dev worflow and other information about our version of `react-scripts` |
0 commit comments