diff --git a/README.md b/README.md index c403366..4ce063c 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,33 @@ -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). +# MCDReforged Website -## Getting Started +The official website of [MCDReforged](https://github.com/MCDReforged/MCDReforged), built usingļ¼š -First, run the development server: +- [Next.js](https://nextjs.org/) +- [Mantine UI](https://mantine.dev/) +- [Tailwind CSS](https://tailwindcss.com/) -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +## Visit the website -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +- Production: https://mcdreforged.com +- Production (backup): https://mcdreforged.vercel.app +- Development: https://mcdreforged-dev.vercel.app (associated with the [dev](https://github.com/MCDReforged/website/tree/dev) branch) -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +## Usage -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +Install requirements -## 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. +```bash +npm install +``` -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +Run dev server -## Deploy on Vercel +```bash +npm run dev +``` -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. +Build -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +```bash +npm run build +```