Skip to content

Commit

Permalink
some minimal improvements + readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
vucinatim committed May 14, 2024
1 parent 1d0c843 commit 35450c3
Show file tree
Hide file tree
Showing 7 changed files with 3,960 additions and 4,997 deletions.
6 changes: 5 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,16 @@ Getting started with this Next.js template is straightforward. Follow these step
- [shadcn/ui](https://ui.shadcn.com/) setup for UI components
- [react-hook-form](https://react-hook-form.com/) for forms
- [zod](https://zod.dev/) for form validation
- Github Actions for lint, typecheck and localizations checks
- [Zodios](https://www.zodios.org/docs/client) for external API calls with validation
- Github Actions for lint, typecheck, localizations checks and tests.

## πŸ“‚ Project Structure

Here's an overview of the folder structure provided in this template:

```bash
.
β”œβ”€β”€ .github # GitHub Actions configurations for CI/CD + PR template
β”œβ”€β”€ .husky # Husky configurations for managing Git hooks
β”œβ”€β”€ .next # Auto-generated folder for optimized production builds
β”œβ”€β”€ .vscode # VSCode settings to maintain consistency in development environments
Expand All @@ -85,13 +87,15 @@ Here's an overview of the folder structure provided in this template:
β”‚ β”‚ β”œβ”€β”€ globals.css # Global CSS styles
β”‚ β”‚ └── layout.tsx # Main layout component
β”‚ β”œβ”€β”€ components # Reusable UI components
β”‚ β”‚ β”œβ”€β”€ common # Common components like providers, headers, footers, etc.
β”‚ β”‚ β”œβ”€β”€ examples # Example components to demonstrate usage
β”‚ β”‚ └── ui # UI specific components like buttons, modals, etc.
β”‚ β”œβ”€β”€ i18n # Internationalization configurations
β”‚ β”‚ β”œβ”€β”€ en # English language translations
β”‚ β”‚ β”œβ”€β”€ sl # Slovenian language translations
β”‚ β”‚ └── ...setup # i18n setup files
β”‚ β”œβ”€β”€ lib # Library code and utility functions
β”‚ β”‚ β”œβ”€β”€ hooks # Custom hooks for common tasks
β”‚ β”‚ └── utils.ts # Utility functions for common tasks
β”‚ β”œβ”€β”€ env.ts # Environment-specific configurations
β”‚ └── middleware.ts # Custom middleware functions
Expand Down
Loading

0 comments on commit 35450c3

Please sign in to comment.