Skip to content

Commit

Permalink
docs: Added documentation for using a GitHub template to bootstrap a …
Browse files Browse the repository at this point in the history
…new project
  • Loading branch information
mlaursen committed Jan 1, 2022
1 parent 51bd110 commit aac11ba
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ Create an accessible React application with the
application
- [Creating a new app](https://react-md.dev/guides/creating-a-new-app) - How to
create a new app with react-md
- [Using a GitHub template](https://github.com/mlaursen/template-rmd) - Create a
new repo from a GitHub template including reasonable react-md defaults and
Next.js.
- [Examples with Build Tools](./examples) - View and download examples of using
ReactMD with build tools such as [create-react-app], [Next.js], and [Gatsby]
- [Working from v1](https://react-md.dev/guides/working-with-v1) - How to use
Expand Down
11 changes: 7 additions & 4 deletions packages/documentation/src/guides/creating-a-new-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ This guide will help you create a new app with `react-md` along with
[create-react-app] as the project bootstrapper. The basic requirements for
continuing are:

- [node] installed with at least version `10` to make things simple
- [node] installed with at least version `14` to make things simple
- [yarn] or [npm]
- experience in React

> You can also check out the
> [GitHub examples folder]({{GITHUB_URL}}/tree/main/examples) to see completed
> examples and other build tools such as [Next.js](https://nextjs.org/).
> If you want to get started immediately, you can view the
> [GitHub examples folder]({{GITHUB_URL}}/tree/main/examples) which outlines
> quick ways to spin up a new project with different build tools. Another
> alternative is using the
> [react-md GitHub template](https://github.com/mlaursen/template-rmd) to
> bootstrap a new repo with Next.js and some reasonable defaults.
## Bootstrapping a new Project

Expand Down

0 comments on commit aac11ba

Please sign in to comment.