Update README
parent
35b7eb15fe
commit
63696f0c86
@ -1,40 +1,38 @@
|
||||
# Bookmark Dashboard made with Next.js & NextUI
|
||||
|
||||
# Next.js & NextUI Template
|
||||
|
||||
This is a template for creating applications using Next.js 13 (app directory) and NextUI (v2).
|
||||
|
||||
## Technologies Used
|
||||
|
||||
- [Next.js 13](https://nextjs.org/docs/getting-started)
|
||||
- [NextUI v2](https://nextui.org/)
|
||||
- [Tailwind CSS](https://tailwindcss.com/)
|
||||
- [Tailwind Variants](https://tailwind-variants.org)
|
||||
- [TypeScript](https://www.typescriptlang.org/)
|
||||
- [Framer Motion](https://www.framer.com/motion/)
|
||||
- [next-themes](https://github.com/pacocoursey/next-themes)
|
||||
- [Next.js 13](https://nextjs.org/docs/getting-started)
|
||||
- [NextUI v2](https://nextui.org/)
|
||||
- [Tailwind CSS](https://tailwindcss.com/)
|
||||
- [Tailwind Variants](https://tailwind-variants.org)
|
||||
- [TypeScript](https://www.typescriptlang.org/)
|
||||
- [Framer Motion](https://www.framer.com/motion/)
|
||||
- [next-themes](https://github.com/pacocoursey/next-themes)
|
||||
|
||||
## How to Use
|
||||
|
||||
|
||||
### Use the template with create-next-app
|
||||
|
||||
To create a new project based on this template using `create-next-app`, run the following command:
|
||||
|
||||
```bash
|
||||
npx create-next-app -e https://github.com/nextui-org/next-app-template
|
||||
```
|
||||
|
||||
### Install dependencies
|
||||
|
||||
```bash
|
||||
npm install
|
||||
pnpm install
|
||||
```
|
||||
|
||||
### Run the development server
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
## License
|
||||
### Deployment (Docker)
|
||||
|
||||
You can deploy using docker-compose, container name: next_dashboard (can be modified in docker-compose.yml)
|
||||
|
||||
Licensed under the [MIT license](https://github.com/nextui-org/next-app-template/blob/main/LICENSE).
|
||||
```bash
|
||||
docker-compose up -d --build
|
||||
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue