traviewhite / next-traviewhite-template

An opinionated boilerplate to kickstart projects using Next.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

next-traviewhite-template

An opinionated boilerplate to kickstart projects using Next.js

This is a Next.js project bootstrapped with create-next-app.

πŸš€ Getting Started

Run the following command to create a new project with this template:

npx creat-next-app <your-app-name> -e https://github.com/traviewhite/next-traviewhite-template
# or
yarn creat-next-app <your-app-name> -e https://github.com/traviewhite/next-traviewhite-template

Once the project and dependencies are installed, navigate to your directory and run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see your project!

You can start editing the page by modifying 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 pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

What's included πŸ‘‡

This Next.js template includes:

  • Sass - Superpowered CSS
  • TypeScript - TypeScript is an open-source language which builds on JavaScript
  • Framer Motion - Library for creating animations
  • include-media - include-media is a Sass library for writing CSS media queries in an easy and maintainable way, using a natural and simplistic syntax

Learn More About Next.js

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

About

An opinionated boilerplate to kickstart projects using Next.js


Languages

Language:SCSS 82.1%Language:JavaScript 17.9%