https://github.com/yummyweb/react-pro
This is the GitHub repository for ReactPro.tech course.
https://github.com/yummyweb/react-pro
Last synced: about 1 month ago
JSON representation
This is the GitHub repository for ReactPro.tech course.
- Host: GitHub
- URL: https://github.com/yummyweb/react-pro
- Owner: yummyweb
- License: mit
- Created: 2021-09-21T16:04:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-21T16:04:38.000Z (over 3 years ago)
- Last Synced: 2024-12-23T21:29:37.502Z (5 months ago)
- Language: JavaScript
- Size: 95.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Next.js course template
This repository contains the source code for a Next.js app you can use to
publish an interactive course with React.
[Click here to see a demo!](https://nextjs-course-template.vercel.app)
This template was created to be used on
[my course on React hooks at useEffect.dev](https://useeffect.dev).
## Features
- Write lessons using [MDX](https://mdxjs.com/).
- Create sublessons to organize your course content.
- Embed source code in several languages.
- Embed interactive and editable React examples.
- Use the template as a base, customize it for your needs!
## This template uses:
- [Next.js](https://nextjs.org/), using static site generation by default.
- [next-mdx-remote](https://github.com/hashicorp/next-mdx-remote) and
[remark](https://remark.js.org/) to parse Markdown.
- [Prism](https://prismjs.com/) to highlight the source code examples, with the
[Dracula theme](https://draculatheme.com/).
- [React Live](https://react-live.netlify.app/) to embed interactive and
editable examples.
- [TailwindCSS](https://tailwindcss.com/) for styling.
## Usage
1. Clone or fork this repository
2. Install dependencies: `yarn`
3. Run the app: `yarn dev`
4. Open http://localhost:3000 and enjoy 😉
The lessons are located in `lessons` directory.
Because of the current implementation (that you are free to improve), here are
the rules the lessons must follow:
- The files must named with `.mdx` extension.
- The header (between `---`) must include a `title` and a type (`foreword`,
`lesson`, `sublesson`, or `appendix`).
- For sublessons, the `parent` attribute in the header must refer to a valid
lesson, and please don’t create loops 😉
- The lessons filenames should be all lowercase.
- The lessons filenames give the order the lessons will be displayed, so I
recommend prefixing them with an index number or letter.
## Any remark/suggestion/issue?
Please submit an issue (or better, a pull request) if you want to report a
problem or suggest an improvement.
But also know that this template is offered free of charge, and I can’t
guarantee to fix all problems 🙂.