From 5a2bb25d1cfc1656bb0ffa2eb979f8184f4bbadc Mon Sep 17 00:00:00 2001 From: Mauricio Siu <47042324+Siumauricio@users.noreply.github.com> Date: Sun, 30 Jun 2024 19:12:19 -0600 Subject: [PATCH] refactor: add readme nextjs --- nextjs-simple/README.md | 44 ++++++++++++++--------------------------- 1 file changed, 15 insertions(+), 29 deletions(-) diff --git a/nextjs-simple/README.md b/nextjs-simple/README.md index c403366..f31a918 100644 --- a/nextjs-simple/README.md +++ b/nextjs-simple/README.md @@ -1,36 +1,22 @@ -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). +# Dokploy Example -## Getting Started +This repository contains an example of nextjs application that is deployed on Dokploy. -First, run the development server: +You have two options to get started: -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +1. **Use Git Provider in Your Application**: + - Repository: `https://github.com/Dokploy/examples.git` + - Branch: `main` + - Build path: `/nextjs-simple` -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +4. **Click on Deploy**: + - Deploy your application by clicking the deploy button. -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +5. **Generate a Domain**: + - Click on generate domain button. + - A new domain will be generated for you. + - You can use this domain to access your application. -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -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. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. + +If you need further assistance, join our [Discord server](https://discord.com/invite/2tBnJ3jDJc).