Mentality App

This is a Next.js project bootstrapped with create-next-app.

You can view the live application at mentality-web.vercel.app.

Getting Started

First, install the dependencies and start the development server:

yarn install
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Eslint & Prettier

Use linter to format the code:

yarn lint
yarn fix

yarn prettier
yarn format

Tests

Check unit tests and coverage:

yarn test
yarn test:cov

Check e2e tests:

yarn cypress run
yarn cypress open

Storybook

Run Storybook for more information:

yarn storybook

Font Optimization

This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.

Commitlint Rules

This project follows specific commit message rules enforced by commitlint . Below are the configured rules:

type-enum

Specifies the types of changes allowed in the commit message. These types help categorize commits and maintain a clean history.

• feat : New feature
• fix : Bug fix
• docs : Documentation changes
• style : Changes that do not affect the meaning of the code (e.g., white-space, formatting)
• refactor : Code changes that neither fix a bug nor add a feature
• perf : Performance improvement
• test : Adding missing tests or correcting existing tests
• build : Changes that affect the build system or external dependencies (e.g., npm)
• ci : Changes to CI configuration files and scripts
• chore : Other changes that don't modifysrc ortest files
• revert : Reverts a previous commit

scope-enum

Defines the allowed scopes of changes. Scopes are used to specify the area of the project affected by the commit.

• setup : Project setup
• config : Configuration files
• deps : Dependency updates
• feature : Feature-specific changes
• bug : Bug fixes
• docs : Documentation
• style : Code style/formatting
• refactor : Code refactoring
• test : Tests
• build : Build scripts or configuration
• ci : Continuous integration
• release : Release-related changes
• other : Other changes

Example Commit Message

Message Writing Pattern

<type-enum>(<optionally: scope-enum>): <short description>

Examples for a Valid Commit Message

• feat(navbar): added ability to sort items

• feat(setup): add commitlint for commit message validation

Ensure all commit messages adhere to these rules to maintain consistency and improve project traceability.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

NextJS and NextUI Dashboard Template Starter

This is a template for NextJS and NextUI.

You can see the demo here: https://nextui-dashboard-template.vercel.app/

Link to the template repository:: https://github.com/Siumauricio/nextui-dashboard-template

• Dark Mode Support
• Full Responsive
• Accounts Page

├── components
│   ├── accounts            # Accounts components
│   ├── breadcrumb          # component
|   ├── home                # Home components
|   ├── layout              # Layout components
|   ├── navbar              # Navbar components
|   ├── sidebar             # Sidebar components
|   ├── table               # Table components
|   ├── styles              # Some reusable components
|   ├── icons               # Icons
|   ├── hooks               # Hooks
├── app                     # Documentation files
│   ├── accounts            # Accounts route
|       ├── page.tsx        # Accounts page
│   ├── page.tsx            # Entry point for the app
│   ├── layout.tsx          # Layout applied to all application pages
│   ├── providers.tsx       # Theme provider
│   ├── more...             # Soon
└──