UNIZAR-30248-2023-01 / maya-frontend

MaYA Frontend

Folder structure

Note _document.js vs. _app.js -- What is the difference?

• _app.js: Core of the application, everything is assembled from here at runtime.
• _document.js: Where side effects are possible.
• context: Encapsulates a global state that can be accessed from anywhere in the application.
• hooks: Encapsulates small pieces of code that represent a certain type of logic.
• lib: Chaos property, stores here functionalities that do not have to do with the rest of the mentioned sections.
• public: Static content.
• styles: Contains the styles of the application. Override or new styles in tailwind.config.js.

Naming convention

• camelCase for variable names and object properties (e.g: SupportedLanguages)
• PascalCase for type names and classes (e.g: ProjectsPage)
• kebab-case for module names (e.g: language-context)

Getting Started

Install dependencies

npm ci

Run for a development environment

git clone -b develop https://github.com/UNIZAR-30248-2023-01/maya-frontend.git
npm ci
npm run dev

Run for a production environment

git clone --depth 1 https://github.com/UNIZAR-30248-2023-01/maya-frontend.git
npm ci
npm run build
npm run start

Compile for docker

docker build -t next-template:latest .

docker run -p 3000:3000 --env-file .env next-template:latest

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

Maintenance & Update to latest

npm install -g npm-check-updates
ncu