{"id":19245817,"url":"https://github.com/reactplay/docs","last_synced_at":"2025-04-21T10:33:22.274Z","repository":{"id":60798760,"uuid":"516963265","full_name":"reactplay/docs","owner":"reactplay","description":"Documentation for ReactPlay.","archived":false,"fork":false,"pushed_at":"2023-10-31T06:31:08.000Z","size":391,"stargazers_count":27,"open_issues_count":8,"forks_count":14,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-01T12:49:27.790Z","etag":null,"topics":["documentation","documentation-site","docusaurus","hacktoberfest","learning","no-code","react","reactjs"],"latest_commit_sha":null,"homepage":"https://docs.reactplay.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reactplay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-07-23T05:07:04.000Z","updated_at":"2025-01-31T14:06:15.000Z","dependencies_parsed_at":"2023-09-29T08:19:46.936Z","dependency_job_id":"0a19664d-b46c-43e5-9a8b-47273224cb1a","html_url":"https://github.com/reactplay/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reactplay%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reactplay%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reactplay%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reactplay%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reactplay","download_url":"https://codeload.github.com/reactplay/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250040448,"owners_count":21365106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","documentation-site","docusaurus","hacktoberfest","learning","no-code","react","reactjs"],"created_at":"2024-11-09T17:29:28.968Z","updated_at":"2025-04-21T10:33:21.529Z","avatar_url":"https://github.com/reactplay.png","language":"JavaScript","readme":"# ReactPlay Docs\nOfficial documentation for ReactPlay.\n \n Check ReactPlay [Official Repository](https://github.com/reactplay/react-play) for more information.\n\n## What is ReactPlay\n![ReactPlay](https://raw.githubusercontent.com/reactplay/react-play/main/src/images/og-image.png)\n`react-play` is an open-source web app that helps you learn ReactJS faster with a hands-on practice model. It is a collection of ReactJS projects you can use to learn ReactJS.\n\nIs that all? Nope. You can also create your projects and share them with the world. The best part is that the ReactJS experts will review your project code before it gets part of the ReactPlay app. Isn't that a pure WIN-WIN?\n\nThis repository serves a documentation for ReactPlay. It includes information on how to perform various activities on the platform.\n\n## 🤩 How to contribute to this repo?\n\nYou can contribute to this repo in several ways:\n1. Write documentation for the various parts of ReactPlay\n2. Suggest changes to the existing docs\n3. Improve the documentation website\n\nTo contribute, you must set up this repository on your local machine. Here is a brief guide on setting up the repo on your local machine:\n\n\u003e Please read [CONTRIBUTING](https://github.com/reactplay/docs/blob/main/CONTRIBUTING.md) for details on our [CODE OF CONDUCT](https://github.com/reactplay/docs/blob/main/CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.\n\n**💡 New to Open Source? Follow [this guide](https://opensource.guide/how-to-contribute/) to jumpstart your Open Source journey 🚀**\n\n### 🍴 Fork and Clone the Repo\nFirst, you need to fork this repo. You can do this by clicking the `Fork` button on the top right corner of the repo. If you are new to forking, please watch this [YouTube Guide](https://www.youtube.com/watch?v=h8suY-Osn8Q) to get started.\n\nOnce forked, click the bright green `\u003c\u003e Code` button and copy the URL.\n\nNow on your local machine, open the destination directory in the terminal and execute the following command:\n\n```bash\ngit clone \u003cURL_LINK\u003e\n```\n\nHere the `URL_LINK` is the same link you coped in the previous step.\n\n\nPlease change the directory after cloning the repository using the ```cd \u003cdirectory-name\u003e``` command.\n\n### ⬆ Set Upstream\nWe recommend setting an upstream repo to make pulling and fetching easier. Execute the following command in the terminal:\n\n```bash\ngit remote add upstream https://github.com/reactplay/docs\n```\n\nCheck if the upstream has been added by executing the following command:\n\n```bash\ngit remote -v\n```\n\n### 🌴 Create a branch\nIdeally, you must create a separate branch for each issue you are working on. Here is how to create a new branch locally.\n\n```bash\ngit checkout -b \u003cbranch-name\u003e\n``` \n\nKeep the branch name clear and straightforward. The `-b` command switches the current branch to the newly created branch. \n\nYou are ready to start working on the issue!\n\n### 👨‍💻 Make changes\nYou need to install dependencies before you start working on the website. Make sure you are in the same directory as your repo's `package.json` and execute either of the following commands:\n\n```bash\nyarn install\n```\n\nWe recommend using Yarn. But feel free to use NPM as well:\n```\nnpm install\n```\n\nTo start a local development server, enter the following command:\n\n```bash\nyarn start\n````\n\nOr, for NPM:\n```bash\nnpm run start\n```\n\nThe local development server will start on localhost:3000\n\n### 🔒 Commit and Push\nYou can save your changes by committing them. Committing once you have made significant changes to the repo is recommended. Execute the following commands:\n\n```bash\ngit add .\ngit commit -m \"\u003cmessage\u003e\"\ngit push -u origin \u003cbranch-name\u003e\n```\nThe `message` should be a descriptive text defining your changes since the last commit.\nThe `branch-name` is the branch name you created before working on this issue.\n\nYou can create multiple commits before pushing the code.\n\n\n### 🙌 Pull Request\nWhen you have resolved the issue, its time to make a pull request.\nOpen the forked repo from GitHub web and go to `Pull Requests` tab. Then click the bright green `New Pull Request` button.\n\nSelect the _base_ and _compare_ branches carefully. Base is the branch you are merging your changes with whereas Compare is the branch you made your changes to.\n![image](https://user-images.githubusercontent.com/53049546/222949792-0d9c1739-3692-4753-8880-2bb1837a43ac.png)\n\nClick `Create Pull Request` and wait until we review and merge it.\n\nUntil it gets merged, browse [ReactPlay](https://reactplay.io/) and [contribute](https://github.com/reactplay/react-play) to it.\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freactplay%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freactplay%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freactplay%2Fdocs/lists"}