{"id":19215988,"url":"https://github.com/movingblocks/adventuresite","last_synced_at":"2025-05-12T23:29:00.591Z","repository":{"id":40284929,"uuid":"269430167","full_name":"MovingBlocks/AdventureSite","owner":"MovingBlocks","description":"The Adventure Site is a web app that provides Terasology’s various documentation resources to new contributors in a conversational form. This “Tutorial Journey” or “Adventure Site” supports new contributors to find suitable resources based on their contribution interests. A user can navigate by conversing with the Gooey and Gooey helps the user to learn more about the projects. Gooey helps the user to access the resources in a sequential order, which helps the user to study all possible resources related to that particular path.","archived":false,"fork":false,"pushed_at":"2023-03-04T22:32:15.000Z","size":14680,"stargazers_count":5,"open_issues_count":19,"forks_count":5,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-20T19:38:13.533Z","etag":null,"topics":["adventuresite","hacktoberfest","reactjs","yarn"],"latest_commit_sha":null,"homepage":"https://terasology.org/AdventureSite/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MovingBlocks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-06-04T18:04:34.000Z","updated_at":"2023-03-18T21:45:10.000Z","dependencies_parsed_at":"2025-04-20T19:46:17.075Z","dependency_job_id":null,"html_url":"https://github.com/MovingBlocks/AdventureSite","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/MovingBlocks%2FAdventureSite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FAdventureSite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FAdventureSite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FAdventureSite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MovingBlocks","download_url":"https://codeload.github.com/MovingBlocks/AdventureSite/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253839641,"owners_count":21972351,"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":["adventuresite","hacktoberfest","reactjs","yarn"],"created_at":"2024-11-09T14:15:27.841Z","updated_at":"2025-05-12T23:29:00.564Z","avatar_url":"https://github.com/MovingBlocks.png","language":"JavaScript","readme":"\u003ch1 style=\"text-align: center;\"\u003eTutorial Journey Website for The Terasology Foundation!\u003c/h1\u003e\n\n[![status](https://img.shields.io/badge/status-pre--alpha-red.svg)](https://github.com/MovingBlocks/AdventureSite)\n[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)\n[![GitHub issues](https://img.shields.io/github/issues/MovingBlocks/AdventureSite.svg)](https://github.com/MovingBlocks/AdventureSite/issues/)\n\n---\n\n\u003cp style=\"text-align: center;\"\u003e\n  \u003ca href=\"#about\"\u003eAbout\u003c/a\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#setup\"\u003eSetup\u003c/a\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#testing\"\u003eTesting\u003c/a\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#deployment\"\u003eDeployment\u003c/a\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n\u003ch2 id=\"about\"\u003eAbout The Project\u003c/h2\u003e\n\nThe Adventure Site is a web app that provides Terasology’s various documentation resources to new contributors in a conversational form. This “Tutorial Journey” or “Adventure Site” supports new contributors to find suitable resources based on their contribution interests. A user can navigate by conversing with the Gooey and Gooey helps the user to learn more about the projects. Gooey helps the user to access the resources in a sequential order, which helps the user to study all possible resources related to that particular path.\n\n---\n\n\u003cp style=\"text-align: center;\"\u003e\n\u003cimg src=\"./AdventureSite.gif\" alt=\"AdventureSite gif\"/\u003e\n\u003c/p\u003e\n\n---\n\n\u003ch2 id=\"project-structure\"\u003eProject Structure\u003c/h2\u003e\n\nThe Paths behind this Adventure Site are defined by a JSON schema in the [pathMap](/src/data/pathMap.jsx).\n\n---\n\n### What is a Path inside [AdventureSite](https://terasology.org/AdventureSite/) -\n\n- A path is nothing but a set of sequential steps that a user will follow.\n- The path will be decided according to the users choice.\n- Every Directory inside `/src/data` shows a group of similar paths and `pathMap.jsx` is the root file which compiles everything in one code.\n\n---\n\n### What is the PathMap -\n\n- PathMap is a JSX file which compiles JSON schema of every path on a high level.\n- Every component inside `/data` directory contains path information for its respective Path.\n- The overall structure of the paths can be represented by a nested JSON.\n- You can find the general structure of each component [here](./pathStructure.md).\n\n---\n\n\u003ch2 id=\"editors-guide\"\u003eEditor's Guide\u003c/h2\u003e\n\n### How to edit a path?\n\n- Open the project inside your favorite editor.\n- Go to the [pathMap](/src/data/pathMap.jsx) file.\n- Navigate to the point where you wish to edit the information.\n  - **How?**\n    - To navigate inside child paths, hold `ctrl` and click on the subPath.\n    - This will take you to that particular path.\n- Make the required edits inside that path ( according to the [Path Structure](./pathStructure.md) ).\n- Save and build the project.\n\n### How to Add a new Path?\n\n- To add a new path we have to decide if it is a totally new path or a subPath?\n- If it is a new path, then you can create a new directory under the `src/data/` and name it accordingly. Also, add an appropriate path by following the [Path Structure](./pathStructure.md).\n- If it is a sub path then create the path file inside the appropriate directory in `src/data/` and name it accordingly.\n- Make sure the path is added inside our existing flow.\n- Path can be imported by using an import statement (similar to react components).\n\n---\n\n\u003ch2 id=\"built-with\"\u003eBuilt With\u003c/h2\u003e\n\nThe following generator is built using the following software, you'll need them installed in your workspace to run properly.\n\n- [Node](https://nodejs.org/en/)\n- [Yarn](https://yarnpkg.com/en/)\n\n---\n\n\u003ch2 id=\"tools-used\"\u003eTools Used\u003c/h2\u003e\n\n- [React](https://reactjs.org/docs/getting-started.html)\n\n- [Sass](https://sass-lang.com/)\n\n\u003ch2 id=\"setup\"\u003eSetup\u003c/h2\u003e\n\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/MovingBlocks/AdventureSite)\n\n- Setting up workspace\n\n  - node\n\n    - Download and setup NodeJs from [https://nodejs.org/en/download/](https://nodejs.org/en/download/)\n\n  - yarn\n\n    - Download and setup yarn package manager from [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)\n\n* Fork the repository\n* Clone the repository `git clone forked-repository-link`\n* Navigate inside the repository `cd AdventureSite`\n* Install the dependencies ( yarn is recommended ) `yarn`\n\n---\n\n\u003ch2 id=\"testing\"\u003eTesting\u003c/h2\u003e\n\nYou can test the website locally using `yarn start`.\n\n\u003ch2 id=\"deployment\"\u003eDeployment\u003c/h2\u003e\n\nYou can the website to GitHub pages using `npm run deploy`.\n\n\u003ch2 id=\"contributing\"\u003eContributing\u003c/h2\u003e\n\nTo add a new feature or fix a bug follow the steps -\n\n- Make sure your local workspace is up-to-date with the main repository.\n\n  - Add the original repository as `upstream` in you local git remote\n\n    `git remote add upstream https://github.com/MovingBlocks/AdventureSite.git`\n\n  - Fetch the latest code `git fetch upstream`\n\n  - Checkout to your local master branch `git checkout master`\n\n  - Merge changes from `upstream/master` to sync `git merge upstream/master`\n\n- Create a new branch to work on the new feature or bug via the updated master branch\n\n  `git checkout -b \"branch_name\"`\n\n- Work on feature/bug and stage all the files to commit it on that branch\n\n  `git add .` \u003e `git commit -m \"Commit Message\"`\n\n- Push the branch to your fork `git push -u origin branch_name`\n\n- Create a pull request.\n\n---\n\n## Contributors\n\nA list of contributors can be found [here](https://github.com/MovingBlocks/AdventureSite/graphs/contributors).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmovingblocks%2Fadventuresite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmovingblocks%2Fadventuresite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmovingblocks%2Fadventuresite/lists"}