Skip to content

Commit 89b62ee

Browse files
committed
docs: add setup instructions to readme (with and without Docker)
1 parent 555faf1 commit 89b62ee

File tree

1 file changed

+11
-29
lines changed

1 file changed

+11
-29
lines changed

README.md

+11-29
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,18 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
2-
31
## Getting Started
42

5-
First, run the development server:
6-
7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
16-
17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
20-
21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
22-
23-
## Learn More
24-
25-
To learn more about Next.js, take a look at the following resources:
3+
### Without Docker
264

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
5+
1. Install: `pnpm install`
6+
2. Run: `pnpm dev`
7+
3. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
298

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
9+
### With Docker
3110

32-
## Deploy on Vercel
11+
1. Build: `docker build -t nextjs-docker .`
12+
2. Run: `docker run -p 3000:3000 --env-file .env.local nextjs-docker`
13+
3. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
3314

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
15+
### Authentication
3516

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
17+
1. Create env file: `cp .env.local.example .env.local`
18+
2. Fill in AUTH prefixed environment variables.

0 commit comments

Comments
 (0)