Skip to content

Commit ecd5912

Browse files
daniel-santos-takingdaniel-santos-taking
committed
chore: init project
0 parents  commit ecd5912

29 files changed

+5284
-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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
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+
}

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Next UI
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

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

0 commit comments

Comments
 (0)