This project is a frontend application built with Next.js, following the principles of Screaming Architecture to maintain clean, modular, and scalable code. It can be run using either pnpm or npm and runs on port 3000 by default.
The branch need to follows the next format: (if a feature) feat/name-branch
And commits need to have the next messages: (If feature) feat: change-description (if update) update: change-description (if remove) remove: change-description
- Node.js
>= 18.x - pnpm
>= 8.x(optional) or npm>= 9.x
Clone the repository** to your local machine:
git clone https://github.com/<your_user>/frontendInstall dependencies using your preferred package manager:
pnpm installnpm installTo start the development server on port 3000:
pnpm devnpm run devThe application will be available at http://localhost:3000.
The project follows Screaming Architecture, meaning the code structure reflects domains and functionalities instead of being technology-based
| Command | Description |
|---|---|
pnpm dev / npm run dev |
Starts the development server |
pnpm build / npm run build |
Builds the application for production |
pnpm start / npm run start |
Runs the production server |
pnpm lint / npm run lint |
Runs the linter to check the code |
To generate an optimized production build:
pnpm build # or npm run buildTo start the application in production mode:
pnpm start # or npm run startThis project is licensed under the MIT license.
This document will be updated as the project evolves.