forked from reactplay/react-play
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
49 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,43 @@ | ||
# Create a Play | ||
|
||
## Table of Contents | ||
- [Steps to Create a Play](#steps-to-create-a-play) | ||
- [Learn about the behind scenes](#learn-about-the-behind-scenes) | ||
- [Frequently Asked Questions](#faq) | ||
|
||
### Steps to Create a Play | ||
Welcome developers! Here are some things you can do to get started with your `Play` creation. | ||
|
||
- Open a command prompt in your project folder. | ||
- Run the following command: | ||
```shell | ||
yarn install | ||
# or | ||
npm install | ||
``` | ||
- After the installation is complete, run the following command: | ||
```shell | ||
yarn plop | ||
``` | ||
- This will ask a few questions about your `Play` and then perform required steps to create the play. The screen shot below shows the output of the command. | ||
<p align="center"> | ||
<img src="./screens/plop-create.png" alt="plop create" /> | ||
</p> | ||
Please find the description of each of the questions in the table below. | ||
|
||
|
||
- Now you can run the app using the following command: | ||
```shell | ||
yarn start | ||
# or | ||
npm start | ||
``` | ||
- You can now see your play added to the [play board](http:https://localhost:3000/plays) page. You can click on the play thumbnail to see the details of the play. | ||
|
||
### Learn about the behind scenes | ||
TBA | ||
|
||
### FAQ | ||
TBA | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.