This is a Next.js project bootstrapped with create-next-app
.
Using VS Code Devcontainer
For quick setup using Docker Desktop
Go to Project Wiki - Quickstart Guide
For more manual setup without using Docker Desktop
Go to Project Wiki - Setup Guide
Developing and Deploying inside Devcontainer
There are two ways to open this project:
- Clone this project and open VS Code, and it should ask you to re-open the project in a container, if it finds the .devcontainer folder.
- Without cloning the project, you can open the VS Code Command Palette, and run
Clone Repository in Container Volume...
.
The first time you do this, it may take a little while as it needs to build the Docker image. After the first load, each time you open the project, it should be much quicker (Unless you change the Dockerfile).
You are now using the Dev Container in VS Code. When you open the terminal, you are inside the container. Plugins are running inside the container too.
Getting Started
First, run the development server inside VS Code Terminal (CTRL + `):
npm run dev
# or
yarn dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.tsx
. 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.ts
.
The pages/api
directory is mapped to /api/*
. Files in this directory are treated as API routes instead of React pages.
Learn More
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
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.