diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index 593db607..b6f8ac3f 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -9,6 +9,14 @@ redirect_from: - "docs/index.html" --- +## Building Your First ReactXP App + +To create your first ReactXP app, do the following: +1. Clone the ReactXP repo ```git clone https://github.com/microsoft/reactxp``` locally. +2. Open the ```samples``` directory and pick one of the samples and copy its directory to a new location. [Hello-World](https://github.com/Microsoft/reactxp/tree/master/samples/hello-world) provides a bare-bones starting app. [Hello-World-js](https://github.com/Microsoft/reactxp/tree/master/samples/hello-world-js) is a variant of Hello-World written in Javascript rather than TypeScript. [TodoList](https://github.com/Microsoft/reactxp/tree/master/samples/TodoList) is a more complex example and is a more appropriate starting point for production applications. +3. Follow the build instructions for the sample you've chosen. +4. If desired, rename the directory and project files to reflect the name of your app. + ## Web Technologies React apps are written using web programming techniques. This documentation assumes that you are already familiar with web programming concepts including the use of JavaScript, the browser DOM, browser event handling, and CSS styling. There are many online tutorials that cover these concepts. @@ -19,10 +27,3 @@ While it is possible to write ReactXP apps in JavaScript, we recommend using Typ If you are new to React, you should first familiarize yourself with the core concepts. We provide an overview and some [simple examples](react_concepts.html). Also refer to the official [React](https://reactjs.org/) and [React Native](https://facebook.github.io/react-native/) documentation sites. -## Building Your First ReactXP App - -The `samples` directory contains a minimal "Hello World" app that demonstrates some basic ReactXP functionality. You can use this as a starting point. Just follow the build instructions in the README file. - -The TodoList sample provides a more complex example. - -The RXPTest sample attempts to exercise all aspects of ReactXP, so it's a good reference for sample usage.