Skip to content

Commit

Permalink
docs: add projects structure section to readme (#88)
Browse files Browse the repository at this point in the history
  • Loading branch information
Skolaczk authored Mar 16, 2024
1 parent 778f6ca commit 060e54d
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,26 @@ npm run dev

and open http://localhost:3000/ to see this app.

## 📁 Project structure

```bash
.
├── .github # GitHub folder
├── .husky # Husky configuration
├── prisma # Prisma schema and migrations
├── public # Public assets folder
└── src
├── __tests__ # Unit and e2e tests
├── actions # Server actions
├── app # Next JS App (App Router)
├── components # React components
├── hooks # Custom hooks
├── lib # Functions and utilities
├── styles # Styles folder
├── types # Type definitions
└── env.mjs # Env variables config file
```

## ⚙️ Scripts overview
The following scripts are available in the `package.json`:
- `dev`: Run development server
Expand Down

0 comments on commit 060e54d

Please sign in to comment.