Skip to content

Commit af91822

Browse files
committed
Initial setup
1 parent 22e9497 commit af91822

35 files changed

+1181
-0
lines changed

.eslintignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.now/*
2+
*.css
3+
.changeset
4+
dist
5+
esm/*
6+
public/*
7+
tests/*
8+
scripts/*
9+
*.config.js
10+
.DS_Store
11+
node_modules
12+
coverage
13+
.next
14+
build
15+
!.commitlintrc.cjs
16+
!.lintstagedrc.cjs
17+
!jest.config.js
18+
!plopfile.js
19+
!react-shim.js
20+
!tsup.config.ts

.eslintrc.json

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
{
2+
"$schema": "https://json.schemastore.org/eslintrc.json",
3+
"env": {
4+
"browser": false,
5+
"es2021": true,
6+
"node": true
7+
},
8+
"extends": [
9+
"plugin:react/recommended",
10+
"plugin:prettier/recommended",
11+
"plugin:react-hooks/recommended",
12+
"plugin:jsx-a11y/recommended"
13+
],
14+
"plugins": ["react", "unused-imports", "import", "@typescript-eslint", "jsx-a11y", "prettier"],
15+
"parser": "@typescript-eslint/parser",
16+
"parserOptions": {
17+
"ecmaFeatures": {
18+
"jsx": true
19+
},
20+
"ecmaVersion": 12,
21+
"sourceType": "module"
22+
},
23+
"settings": {
24+
"react": {
25+
"version": "detect"
26+
}
27+
},
28+
"rules": {
29+
"no-console": "warn",
30+
"react/prop-types": "off",
31+
"react/jsx-uses-react": "off",
32+
"react/react-in-jsx-scope": "off",
33+
"react-hooks/exhaustive-deps": "off",
34+
"jsx-a11y/click-events-have-key-events": "warn",
35+
"jsx-a11y/interactive-supports-focus": "warn",
36+
"prettier/prettier": "warn",
37+
"no-unused-vars": "off",
38+
"unused-imports/no-unused-vars": "off",
39+
"unused-imports/no-unused-imports": "warn",
40+
"@typescript-eslint/no-unused-vars": [
41+
"warn",
42+
{
43+
"args": "after-used",
44+
"ignoreRestSiblings": false,
45+
"argsIgnorePattern": "^_.*?$"
46+
}
47+
],
48+
"import/order": [
49+
"warn",
50+
{
51+
"groups": [
52+
"type",
53+
"builtin",
54+
"object",
55+
"external",
56+
"internal",
57+
"parent",
58+
"sibling",
59+
"index"
60+
],
61+
"pathGroups": [
62+
{
63+
"pattern": "~/**",
64+
"group": "external",
65+
"position": "after"
66+
}
67+
],
68+
"newlines-between": "always"
69+
}
70+
],
71+
"react/self-closing-comp": "warn",
72+
"react/jsx-sort-props": [
73+
"warn",
74+
{
75+
"callbacksLast": true,
76+
"shorthandFirst": true,
77+
"noSortAlphabetically": false,
78+
"reservedFirst": true
79+
}
80+
],
81+
"padding-line-between-statements": [
82+
"warn",
83+
{"blankLine": "always", "prev": "*", "next": "return"},
84+
{"blankLine": "always", "prev": ["const", "let", "var"], "next": "*"},
85+
{
86+
"blankLine": "any",
87+
"prev": ["const", "let", "var"],
88+
"next": ["const", "let", "var"]
89+
}
90+
]
91+
}
92+
}

.gitignore

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# next.js
12+
/.next/
13+
/out/
14+
15+
# production
16+
/build
17+
18+
# misc
19+
.DS_Store
20+
*.pem
21+
22+
# debug
23+
npm-debug.log*
24+
yarn-debug.log*
25+
yarn-error.log*
26+
27+
# local env files
28+
.env*.local
29+
30+
# vercel
31+
.vercel
32+
33+
# typescript
34+
*.tsbuildinfo
35+
next-env.d.ts

.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
public-hoist-pattern[]=*@nextui-org/*
2+
package-lock=false

.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"typescript.tsdk": "node_modules/typescript/lib"
3+
}

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,54 @@
11
# nextjs-with-nextui
22
This is template repository for a nextjs app with nextui and tailwindcss
3+
4+
This is a template for creating applications using Next.js 14 (app directory) and NextUI (v2).
5+
6+
[Try it on CodeSandbox](https://githubbox.com/nextui-org/next-app-template)
7+
8+
## Technologies Used
9+
10+
- [Next.js 14](https://nextjs.org/docs/getting-started)
11+
- [NextUI v2](https://nextui.org/)
12+
- [Tailwind CSS](https://tailwindcss.com/)
13+
- [Tailwind Variants](https://tailwind-variants.org)
14+
- [TypeScript](https://www.typescriptlang.org/)
15+
- [Framer Motion](https://www.framer.com/motion/)
16+
- [next-themes](https://github.com/pacocoursey/next-themes)
17+
18+
## How to Use
19+
20+
### Use the template with create-next-app
21+
22+
To create a new project based on this template using `create-next-app`, run the following command:
23+
24+
```bash
25+
npx create-next-app -e https://github.com/nextui-org/next-app-template
26+
```
27+
28+
### Install dependencies
29+
30+
You can use one of them `npm`, `yarn`, `pnpm`, `bun`, Example using `npm`:
31+
32+
```bash
33+
npm install
34+
```
35+
36+
### Run the development server
37+
38+
```bash
39+
npm run dev
40+
```
41+
42+
### Setup pnpm (optional)
43+
44+
If you are using `pnpm`, you need to add the following code to your `.npmrc` file:
45+
46+
```bash
47+
public-hoist-pattern[]=*@nextui-org/*
48+
```
49+
50+
After modifying the `.npmrc` file, you need to run `pnpm install` again to ensure that the dependencies are installed correctly.
51+
52+
## License
53+
54+
Licensed under the [MIT license](https://github.com/nextui-org/next-app-template/blob/main/LICENSE).

next.config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/** @type {import('next').NextConfig} */
2+
const nextConfig = {}
3+
4+
module.exports = nextConfig

package.json

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
{
2+
"name": "nextjs-with-nextui",
3+
"version": "0.0.1",
4+
"private": true,
5+
"scripts": {
6+
"dev": "next dev --turbo",
7+
"build": "next build",
8+
"start": "next start",
9+
"lint": "eslint . --ext .ts,.tsx -c .eslintrc.json --fix"
10+
},
11+
"dependencies": {
12+
"@nextui-org/button": "2.0.38",
13+
"@nextui-org/code": "2.0.33",
14+
"@nextui-org/input": "2.2.5",
15+
"@nextui-org/kbd": "2.0.34",
16+
"@nextui-org/link": "2.0.35",
17+
"@nextui-org/listbox": "2.1.27",
18+
"@nextui-org/navbar": "2.0.37",
19+
"@nextui-org/snippet": "2.0.43",
20+
"@nextui-org/switch": "2.0.34",
21+
"@nextui-org/system": "2.2.6",
22+
"@nextui-org/theme": "2.2.11",
23+
"@react-aria/ssr": "3.9.4",
24+
"@react-aria/visually-hidden": "3.8.12",
25+
"@types/bootstrap": "^5.2.10",
26+
"bootstrap": "^5.3.3",
27+
"clsx": "2.1.1",
28+
"firebase": "^10.13.1",
29+
"firebase-admin": "^12.5.0",
30+
"framer-motion": "~11.1.1",
31+
"intl-messageformat": "^10.5.0",
32+
"next": "14.2.4",
33+
"next-themes": "^0.2.1",
34+
"react": "18.3.1",
35+
"react-dom": "18.3.1",
36+
"react-hot-toast": "^2.4.1",
37+
"react-icons": "^5.3.0"
38+
},
39+
"devDependencies": {
40+
"@types/node": "20.5.7",
41+
"@types/react": "18.3.3",
42+
"@types/react-dom": "18.3.0",
43+
"@typescript-eslint/eslint-plugin": "7.2.0",
44+
"@typescript-eslint/parser": "7.2.0",
45+
"autoprefixer": "10.4.19",
46+
"eslint": "^8.57.0",
47+
"eslint-config-next": "14.2.1",
48+
"eslint-config-prettier": "^8.2.0",
49+
"eslint-plugin-import": "^2.26.0",
50+
"eslint-plugin-jsx-a11y": "^6.4.1",
51+
"eslint-plugin-node": "^11.1.0",
52+
"eslint-plugin-prettier": "^5.1.3",
53+
"eslint-plugin-react": "^7.23.2",
54+
"eslint-plugin-react-hooks": "^4.6.0",
55+
"eslint-plugin-unused-imports": "^3.2.0",
56+
"postcss": "8.4.38",
57+
"tailwind-variants": "0.1.20",
58+
"tailwindcss": "3.4.3",
59+
"typescript": "5.0.4"
60+
}
61+
}

postcss.config.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
module.exports = {
2+
plugins: {
3+
tailwindcss: {},
4+
autoprefixer: {},
5+
},
6+
}

public/favicon.ico

25.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)