https://github.com/reactplay/create-react-play
This is a npm package which works as a backbone of the application. This makes the application management more controlled. more controlled.
https://github.com/reactplay/create-react-play
hacktoberfest
Last synced: 9 months ago
JSON representation
This is a npm package which works as a backbone of the application. This makes the application management more controlled. more controlled.
- Host: GitHub
- URL: https://github.com/reactplay/create-react-play
- Owner: reactplay
- License: mit
- Created: 2022-06-19T06:47:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-13T03:17:02.000Z (about 2 years ago)
- Last Synced: 2025-04-18T14:16:01.889Z (9 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 78.1 KB
- Stars: 11
- Watchers: 3
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Create React Play
## Welcome to `reactplay.io` ecosystem
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.
[](https://github.com/reactplay/create-react-play/actions/workflows/npm-publish.yml)
## Command Line Options
Here are few options
- -h/help: Show all available arguments and flags
- -c/create: Creates a play boilerplate within local directory structure
- -u/update: Update an exsiting play
- -p/prepare: Prepre an environment for build/run
## How it works
### Example: Create a play
1. Fork [reactplay](https://github.com/reactplay/react-play)
2. Clone your branch
3. Install packages using
```bash
yarn
#or
npm install
```
4. run reactplay application using
```bash
yarn start
#or
npm start
```
5. Hit "Create" button on web portal
6. Provide necessary information
7. Submit your play request
8. It will generate an unique id for you
9. Navigate to root directory of your local reactplay repo and run
```bash
npx create-react-play -c
```
This will create necessary resources and link them together.
**Note:** If the play folder `/plays/` remain empty after running above command that means you might be in some older version of the package. Use `@latest` in that case
```bash
npx create-react-play@latest -c
```
10. Now you will find your play under
```
/plays/
```
11. Now its all with you, create an awesome play and flaunt it infront of the globe
12. Create a pull request when you are done
### Example: Prepare environemnt
```bash
npx create-react-play@latest -p
```