An opinionated starter template for building a TypeScript NextJS app on Netlify.
This comes with TypeScript, Github Actions, ESLint, Jest, TailwindCSS, and Netlify all setup out of the box.
- Framework: NextJS
- Markdown Rendering: React Markdown
- Code Highlighting: React Syntax Highlighter
- Hosting: Netlify
- CMS: Netlify CMS
- CI/CD: Github Actions
- Styling: TailwindCSS
- Language: TypeScript
- Lint: ESLint with opinionated form of AirBNB rules
- Tests: Jest
Use this deploy button to get your own copy of the repository.
This button will do the following:
Connect to your GitHub account and create a new repository with the name you specify
- Deploy your copy of the repository and setup continuous deployment
- Send an invite to the email address associated with your Netlify account
- Accept the invite, set your password, then navigate to
/admin/
on your site to log in.
Now you're all set, and you can start customizing your static site!
After using the deploy button above, clone your copy of the repository and run:
$ yarn install
$ yarn start
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying src/pages/index.js
. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in src/pages/api/hello.js
.
The src/pages/api
directory is mapped to /api/*
. Files in this directory are treated as API routes instead of React pages.
Released under the MIT License.