{"id":20169133,"url":"https://github.com/developer-dao/academy","last_synced_at":"2025-06-26T01:39:41.692Z","repository":{"id":38298210,"uuid":"493382363","full_name":"Developer-DAO/academy","owner":"Developer-DAO","description":"Deprecated; V2 lives at https://github.com/developer-dao/academy-turbo","archived":false,"fork":false,"pushed_at":"2024-01-21T01:27:05.000Z","size":26131,"stargazers_count":111,"open_issues_count":32,"forks_count":52,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-12-07T16:21:35.397Z","etag":null,"topics":["dao","education","web3"],"latest_commit_sha":null,"homepage":"https://academy.developerdao.com","language":"MDX","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/Developer-DAO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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}},"created_at":"2022-05-17T19:12:16.000Z","updated_at":"2024-11-11T00:41:01.000Z","dependencies_parsed_at":"2023-02-19T01:16:02.854Z","dependency_job_id":"ab247702-8e5f-4cee-a1cb-417ae7afb33d","html_url":"https://github.com/Developer-DAO/academy","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/Developer-DAO%2Facademy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Developer-DAO%2Facademy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Developer-DAO%2Facademy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Developer-DAO%2Facademy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Developer-DAO","download_url":"https://codeload.github.com/Developer-DAO/academy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230520391,"owners_count":18238948,"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":["dao","education","web3"],"created_at":"2024-11-14T01:11:30.796Z","updated_at":"2024-12-20T01:14:30.457Z","avatar_url":"https://github.com/Developer-DAO.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Developer DAO Academy\n\n`Developer DAO Academy` is an open-source education platform created by the\nDeveloper DAO Foundation.\n\nLive site is at \u003chttps://academy.developerdao.com\u003e.\n\nFind us on Twitter at \u003chttps://twitter.com/devdao_academy\u003e.\n\n![Academy Homepage Screenshot](./public/landing-page-screenshot.png)\n\n## What license applies to this site's content and code?\n\n- All Developer DAO Academy website content © 2022 by Developer DAO Foundation\n  licensed under\n  [Attribution-NonCommercial 4.0 International](http://creativecommons.org/licenses/by-nc/4.0/).\n- Developer DAO Academy website code © 2022 by Developer DAO Foundation licensed\n  under [MIT](./LICENSE).\n\n## How do I get started?\n\nPlease read our [CONTRIBUTING Guide](CONTRIBUTING.md) to get started. We ask\nthat you are a member of Developer DAO to contribute, since our project uses\nvarious Developer DAO planning and communication tools, such as Discord.\n\n## How to contribute code\n\nIf you're new to the project, see below for setup instructions.\n\n### Considerations as you write code\n\nAs you're working on code, some things to think about:\n\n- PRs should be as small as possible so they are easy to review\n- There are strategies you can use to keep PRs small, even if your feature is\n  big.\n  [How to Split Pull Requests – Good Practices, Methods and Git Strategies](https://www.thedroidsonroids.com/blog/splitting-pull-request)\n\n### What should I do before submitting the PR?\n\n- Run `yarn confirm` which will make sure your files are consistently formatted,\n  lint the code base looking for problems and then actually building the site\n  locally to ensure no build problems\n- If you see warnings or errors please fix.\n- Also, this step runs Prettier so some files may have changed and need to be\n  checked in.\n\nNow you're ready to submit your PR.\n\nAssume no one knows what your PR is about. So helpful to:\n\n- writing a description in the PR to explain what you're fixing/adding and how\n  to test.\n- if your work is based on a GitHub issue, add that in the description, though\n  make sure you use the exact words of \"Closes #123\" since this will\n  automatically close the issue when the PR is merged. Using \"this refers to\n  #123\" won't do that.\n- send a signal that your PR is ready for review, such as asking someone to\n  review your PR\n\n### How do I review a PR?\n\nIt's also important that people review PRs -- a great learning experience and\nimportant for an open-source project.\n\nSome helpful things when reviewing PRs:\n\n- **ALWAYS** download and run the code you're reviewing. Never eyeball it in the\n  PR and approve it.\n- when you review a PR, please add yourself as a reviewer in GitHub so we know\n  someone is reviewing\n- go through the formal GitHub review process of starting a review and then\n  finishing with \"approved\" or \"needs changes\"\n\n### Who should merge the PR?\n\nOnce a PR is reviewed, the author of the PR should merge, and the author should\nrun through the live site and make sure the code is performing as expected.\n\n## Project Setup\n\n**Prerequisites:**\n\n    node --version 18.x\n\nRefer to the `node` and `npm` installation with `nvm` guide in Lesson 2. A link\nto the guide can be found\n[here](https://www.notion.so/How-to-install-node-js-and-npm-67b2ab1f76f148f49f547b9156aeaf28):\n\n**Fork this repo, clone forked repo locally and `cd` into the repo:**\n\n    git clone https://github.com/[YOUR GITHUB HANDLE HERE]/academy.git\n    cd academy/\n\n**Installation and run:**\n\n    yarn install\n    yarn dev\n\nThis will create a local instance of the app running and can be viewed at\n`http://localhost:3000` in your browser.\n\nAlso it's handy to install the Prettier plugin for your browser. You can then\nuse it to automatically format files. It helps keep the code base tidy, for\nTypescript, MDX and Markdown files.\n\n**VSCode Remote Containers (alternative setup)**\n\nIf you use VSCode for development, we already have the configuration files for\nyou to use\n[Remote Containers](https://code.visualstudio.com/docs/remote/containers) (make\nsure that you check the link to install the requirements to use it) to easily\ncreate an isolated development environment for your fork. After installing the\nminimum requirements, you can start using it following this\n[quickstart](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume).\n\n**For Windows Users**\n\nYou may run into setup problems if using Windows Powershell. We suggest you use\nWSL.\n\n## Grabbing latest version of the code\n\n**Since this is a work in progress, your local version of the app can be updated\nwith the following commands:**\n\nStop the locally running app with:\n\n    Ctrl + C\n\nUse `git pull` for the most up-to-date version:\n\n    git pull\n\nReinstall with `yarn`:\n\n    yarn install\n\nRun the updated app:\n\n    yarn dev\n\n## Learn More\n\nTo learn more about Next.js, take a look at the following resources:\n\n- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js\n  features and API.\n- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.\n\nYou can check out\n[the Next.js GitHub repository](https://github.com/vercel/next.js/) - your\nfeedback and contributions are welcome!\n\n## Storybook\n\nThis project uses [Storybook](https://storybook.js.org/). Storybook allows us to\ndevelop components in isolation from our app.\n\nStories are loaded from `*.stories.(mdx|js|jsx|ts|tsx)` files in any directory.\n\nTo use Storybook, run the `storybook` script:\n\n```bash\nyarn storybook\n```\n\nTo learn more about how to write Storybook stories, check out the official\n[Intro to Storybook](https://storybook.js.org/tutorials/intro-to-storybook/)\ntutorial.\n\n## Deploy on Vercel\n\nThe easiest way to deploy your Next.js app is to use the\n[Vercel Platform](https://vercel.com/new?utm_medium=default-template\u0026filter=next.js\u0026utm_source=create-next-app\u0026utm_campaign=create-next-app-readme)\nfrom the creators of Next.js.\n\nCheck out our\n[Next.js deployment documentation](https://nextjs.org/docs/deployment) for more\ndetails.\n\n## How do I add/edit contributors for a lesson?\n\nFirst make sure you add your information to `./data/contributors.ts`. Minimally\nyou need a unique handle (a single lowercase name such as `brianfive`) which\nwill be used to look up your information.\n\nThen add a component in your `.mdx` file at the bottom like this, using various\nhandles defined above.\n\nYou can add a contributor as an author, reviewer of contributor. Author(s) wrote\nthe content, Reviewer(s) edited the content, and Contributor(s) later made\nupdates or fixed issues.\n\n```jsx\nimport { ContributorFooter } from \"../../../components/mdx/ContributorFooter\";\n```\n\n```jsx\n\u003cContributorFooter\n  authors={[\"brianfive\"]}\n  reviewers={[\"piablo\", \"georgemac510\"]}\n  contributors={[]}\n/\u003e\n```\n\n## How do I add a specific forum link in a lesson's header?\n\nMake sure the `\u003cLessonHeader /\u003e` component has the `discussionUrl` attribute\nlike this:\n\n```jsx\n\u003cLessonHeader\n  title=\"Lesson 4: Testing your TierNFT\"\n  discussionUrl=\"https://developerdao.peeranha.io/discussions/1372/testing-solidity-contracts\"\n/\u003e\n```\n\nWithout `discussionUrl` the link will default to the home page of Peeranha.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeveloper-dao%2Facademy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeveloper-dao%2Facademy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeveloper-dao%2Facademy/lists"}