https://github.com/apollo-level2-web-dev/foundx-client
https://github.com/apollo-level2-web-dev/foundx-client
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/apollo-level2-web-dev/foundx-client
- Owner: Apollo-Level2-Web-Dev
- License: mit
- Created: 2024-09-08T15:16:57.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-27T14:00:47.000Z (8 months ago)
- Last Synced: 2024-11-29T12:26:55.184Z (6 months ago)
- Language: TypeScript
- Size: 1.39 MB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Next.js & NextUI Template
This is a template for creating applications using Next.js 14 (app directory) and NextUI (v2).
[Try it on CodeSandbox](https://githubbox.com/nextui-org/next-app-template)
## Technologies Used
- [Next.js 14](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
You can use one of them `npm`, `yarn`, `pnpm`, `bun`, Example using `npm`:
```bash
npm install
```
### Run the development server
```bash
npm run dev
```
### Setup pnpm (optional)
If you are using `pnpm`, you need to add the following code to your `.npmrc` file:
```bash
public-hoist-pattern[]=*@nextui-org/*
```
After modifying the `.npmrc` file, you need to run `pnpm install` again to ensure that the dependencies are installed correctly.
## License
Licensed under the [MIT license](https://github.com/nextui-org/next-app-template/blob/main/LICENSE).