Skip to content

Commit

Permalink
Merge pull request YJU-OKURA#145 from yuminn-k/docs/update-directory-…
Browse files Browse the repository at this point in the history
…structure

README.mdにディレクトリ構造を追加
  • Loading branch information
yuminn-k authored May 21, 2024
2 parents 5f2216c + c562824 commit 2dd9ee4
Showing 1 changed file with 44 additions and 7 deletions.
51 changes: 44 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,48 @@
# yuminnk-nextjs-template
# project_minori-next-deployment-repo

This is a Next.js boilerplate project created using `npx create-next-app`. It comes with TypeScript support and includes GTS, commitlint, husky, and Jest.

## Getting Started
To get started, clone the repository and install the dependencies using `yarn`. Then, run the development server using `yarn dev`.
## Directory Structure
```
.
├── Dockerfile
├── README.md
├── tests
│ ├── snapshots
│ ├── api
│ └── snapshot.js
├── public
│ ├── fonts
│ ├── gif
│ ├── images
│ └── svgs
├── src
│ ├── api
│ ├── app
│ │ ├── classes
│ │ ├── components
│ │ ├── googleLogin
│ │ ├── layout.tsx
│ │ ├── not-found.tsx
│ │ └── page.tsx
│ ├── components
│ ├── constants
│ ├── hooks
│ ├── interfaces
│ ├── model
│ ├── recoil
│ └── styles
├── commitlint.config.js
├── jest.config.ts
├── jest.setup.ts
├── minori-next-task.json
├── next-env.d.ts
├── next.config.js
├── package-lock.json
├── package.json
├── postcss.config.js
├── tailwind.config.ts
├── tsconfig.json
└── yarn.lock
```

## Scripts
- `dev`: Runs the development server
Expand All @@ -15,8 +54,6 @@ To get started, clone the repository and install the dependencies using `yarn`.
- `postinstall`: Sets up Husky for Git hooks
- `lint-staged`: Runs ESLint on staged files

Feel free to customize this template to fit your needs!

## Version
- Next.js: 14.0.4
- TypeScript: 5.3.3
Expand Down

0 comments on commit 2dd9ee4

Please sign in to comment.