Skip to content

Latest commit

 

History

History
106 lines (77 loc) · 5.17 KB

README.md

File metadata and controls

106 lines (77 loc) · 5.17 KB
Raw

Universiteams-front

Pro Scientific Dissemination & Volunteering

Getting started

Nodejs

Clone this repository, then open it with a code editor and execute the command npm install.

If the dependencies are not installed with the above command, you must install Node.js on your machine.

Make

Only in case you happen to use Windows install Chocolatey package manager Then install Make with the following command:

$ choco install make

Run a server

To run a server on development mode you need to execute:

make dev

To be able to visualize the dev server running, you must open http://localhost:3000.

By default, the utilized port will be 3000, but this can be configured and changed for other port.

To build the system for production you must execute:

make build

To run a server on production mode you need to execute:

make prod

Repository edit

The repository's root path is src/app/layout.tsx.

Each new component must be created inside the components folder. These are server-side rendered when they are called on any of the pages. Suppose we have a component called "Dropdown", it will be rendered on a page that contains the <Dropdown /> tag.

Documentation about Next.js

Important and interesting documentation of Next.js can be consulted at:

Technologies used

Frontend

Name How it contributes to the project
👔 TypeScript Programming language that builds on JavaScript
🚀 Next.js Fullstack framework for React.js
🧺 Mantine Really cool component library
🦴 HTML5 & CSS3 The basics for the web!
🎨 Sass CSS Simple stylization
🖼️ Tabler Icons Icons Mantine-compatible
📇 React-PDF Make customizable PDF reports
🖌️ Prettier Nice code formatter
📐 ESLint Complete linter with strict rules
🦮 Husky Git hooks to assure quality commits
🧪 Jest Easy unit testing
📦 TurboPack JavaScript very fast bundler
📃 GitHub Actions CI/CD automation
🔼 Deploy in Vercel Deployment is very important!

Backend

Name How it contributes to the project
👔 TypeScript Programming language that builds on JavaScript
📗 Node.js JavaScript runtime built on V8 JavaScript engine
🐱 Nest.js Framework for building efficient, scalable Node.js web apps
🗺️ TypeORM Object-relational mapping (ORM) tool for Node.js
🗃️ PostgreSQL Open-source relational database management system (RDBMS)
💾 JSON Web Token (JWT) Compact and self-contained way for securely transmitting info
🖌️ Prettier Nice code formatter
📐 ESLint Complete linter with strict rules
🧪 Jest Easy unit testing
⚗️ Supertest High-level HTTP abstraction for E2E integration testing
📖 Swagger Interactive, machine and human-readable API documentation
⚙️ Traefik HTTP reverse proxy and load balancer
🐳 Docker Separates the app from the infrastructure with containers
☁️ Terraform Infrastructure as code tool to manage the infra in any cloud
✈️ New Relic Monitor and analyze deployments
💧 DigitalOcean Droplet Deploy in scalable cloud virtual machines

Authors

Name GitHub Account
:octocat: Alejandro Recalde 🔗 https://github.com/alereca
:octocat: Nicolás Antonelli 🔗 https://github.com/NicoAntonelli
:octocat: Joshua Acciarri 🔗 https://github.com/JAcciarri