|
1 | | -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
| 1 | +Because of some issues with `npm link` I am using |
| 2 | +<a href="https://github.com/whitecolor/yalc">yalc<a/> |
| 3 | +which is like a local npm remote registry. |
2 | 4 |
|
3 | | -## Available Scripts |
| 5 | +## Setup React-Typescript Example |
4 | 6 |
|
5 | | -In the project directory, you can run: |
| 7 | +#### 1. Run `npm install` at the root of Agile |
| 8 | +At first, we have to install some 'global' dependencies of Agile |
6 | 9 |
|
7 | | -### `yarn start` |
| 10 | +#### 2. Run `npm run install` at the root of Agile |
| 11 | +This will install the dependencies of the Agile packages (core, react, api) |
8 | 12 |
|
9 | | -Runs the app in the development mode.<br /> |
10 | | -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
| 13 | +#### 3. Run `npm run dev-publish` at the root of Agile |
| 14 | +As a next step we have to `publish` the Agile packages to the `yalc` repository. |
11 | 15 |
|
12 | | -The page will reload if you make edits.<br /> |
13 | | -You will also see any lint errors in the console. |
| 16 | +#### 4. Run `npm run dev-push` at the root of Agile |
| 17 | +After 'publishing' the Agile Packages we can apply changes to it by running this command. / |
| 18 | +Which builds the Agile packages and push them to `yalc`. / |
| 19 | +All projects that are using the Agile `yalc` dependency will receive the changes. |
14 | 20 |
|
15 | | -### `yarn test` |
| 21 | +#### 5. Run `npm run install-agile` in this Project |
| 22 | +As last step we want to install the Agile dependencies and of course also the other deps. |
16 | 23 |
|
17 | | -Launches the test runner in the interactive watch mode.<br /> |
18 | | -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
19 | | - |
20 | | -### `yarn build` |
21 | | - |
22 | | -Builds the app for production to the `build` folder.<br /> |
23 | | -It correctly bundles React in production mode and optimizes the build for the best performance. |
24 | | - |
25 | | -The build is minified and the filenames include the hashes.<br /> |
26 | | -Your app is ready to be deployed! |
27 | | - |
28 | | -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
29 | | - |
30 | | -### `yarn eject` |
31 | | - |
32 | | -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
33 | | - |
34 | | -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
35 | | - |
36 | | -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
37 | | - |
38 | | -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
39 | | - |
40 | | -## Learn More |
41 | | - |
42 | | -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
43 | | - |
44 | | -To learn React, check out the [React documentation](https://reactjs.org/). |
| 24 | +##### Global installed packages will end here: |
| 25 | +`C:\Users\'your_name'\AppData\Roaming\npm\node_modules\@agile-ts\core` |
0 commit comments