|
1 | | -# React-Play Development Kit |
| 1 | +# Create React Play |
2 | 2 |
|
3 | | -## Prerequisite |
4 | | -1. GitHUb ssh to be configured |
| 3 | +## Welcome to `reactplay.io` ecosystem |
| 4 | + |
| 5 | +A package to generate boilerplate files for creating a play withing your local system. Another idea of this package to create a backbone structure for running all sort of maintenance and house keeping task. |
| 6 | + |
| 7 | +## Command Line Options |
| 8 | +Here are few options |
| 9 | +- -h/help: Show all available arguments and flags |
| 10 | +- -c/create: Creates a play boilerplate within local directory structure |
| 11 | +- -u/update: Update an exsiting play |
| 12 | +- -p/prepare: Prepre an environment for build/run |
| 13 | + |
| 14 | +## How it works |
| 15 | + |
| 16 | +### Example: Create a play |
| 17 | +1. Fork [reactplay](https://github.com/reactplay/react-play) |
| 18 | +2. Clone your branch |
| 19 | +3. Install packages using |
| 20 | + ```bash |
| 21 | + yarn |
| 22 | + #or |
| 23 | + npm install |
| 24 | + ``` |
| 25 | +4. run reactplay application using |
| 26 | + ```bash |
| 27 | + yarn start |
| 28 | + #or |
| 29 | + npm start |
| 30 | + ``` |
| 31 | +5. Hit "Create" button on web portal |
| 32 | +6. Provide necessary information |
| 33 | +7. Submit your play request |
| 34 | +8. It will generate an unique id for you |
| 35 | +9. <b>Navigate to root directory of your local reactplay repo and run |
| 36 | + ```bash |
| 37 | + npx create-react-play -c <the_unique_id> |
| 38 | + ``` |
| 39 | + This will create necessary resources and link them together. |
| 40 | + </b> |
| 41 | +10. Now you will find your play under |
| 42 | + ``` |
| 43 | + <reactplay_directory>/plays/<your_play_name> |
| 44 | + ``` |
| 45 | +11. Now its all with you, create an awesome play and flaunt it infront of the globe |
| 46 | +12. Create a pull request when you are done |
| 47 | +
|
| 48 | +### Example: Prepare environemnt |
| 49 | +```bash |
| 50 | + npx create-react-play -p |
| 51 | +``` |
0 commit comments