docs: Update README.md with comprehensive project details, technology stack, and development guidelines.

This commit is contained in:
JuruSysadmin 2026-01-14 12:28:27 -03:00
parent 8938ae853c
commit cf7e56e2b7
1 changed files with 60 additions and 23 deletions

View File

@ -1,36 +1,73 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). # Portal Web V2
## Getting Started This repository contains the source code for the Portal Web V2 application, a modern enterprise web interface built with Next.js 16 and React 19.
First, run the development server: ## Overview
```bash The application is designed to provide a robust and scalable frontend interface for the Portal system. It leverages a modern technology stack to ensure performance, maintainability, and type safety.
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. ### Technology Stack
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - **Framework:** Next.js 16 (App Router)
- **UI Library:** React 19 with Material UI (MUI) v7
- **State Management:** Zustand and TanStack Query (React Query)
- **Styling:** Tailwind CSS v4 and Emotion
- **Form Management:** React Hook Form with Zod validation
- **Testing:** Jest
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. ## Prerequisites
## Learn More - Node.js (Latest LTS version recommended)
- npm or yarn package manager
To learn more about Next.js, take a look at the following resources: ## Installation
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. 1. Clone the repository:
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. ```bash
git clone <repository-url>
```
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! 2. Navigate to the project directory:
```bash
cd portal-web-v2
```
## Deploy on Vercel 3. Install dependencies:
```bash
npm install
```
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. ## Key Scripts
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. The following scripts are available in `package.json` for development and operations:
| Script | Description |
|--------|-------------|
| `npm run dev` | Starts the development server with hot-reloading. |
| `npm run build` | Compiles the application for production deployment. |
| `npm start` | Runs the compiled production build locally. |
| `npm run lint` | Runs ESLint to analyze code quality and fix issues. |
| `npm test` | Executes the test suite using Jest. |
| `npm run test:coverage` | Runs tests and generates a code coverage report. |
## Project Structure
The project follows the standard Next.js App Router structure:
- `src/`: Contains the source code.
- `app/`: Next.js App Router pages and layouts.
- `components/`: Shared UI components.
- `features/`: Feature-specific modules (Deep Domain Design).
- `hooks/`: Custom React hooks.
- `utils/`: Utility functions and helpers.
- `styles/`: Global styles and theme configurations.
## Development Standards
- **Strict Typing:** TypeScript is enforced throughout the codebase.
- **Code Quality:** ESLint and Prettier configurations are in place to maintain code consistency.
- **Component Architecture:** Components should be atomic and reusable where possible.
## License
Private and Confidential. All rights reserved.