Skip to content

team120/Universiteams

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Universiteams

dockeri.co

This project was thought in order to facilitate the creation, management and formalization of university research projects. Both students and teachers will be able to organize their projects, which will be visible to other students who may want to join the research team. It mainly consists of a web application, the main page will contain all the projects in order to make them known for everyone, and they will be accepting requests for those who want to get in.

Our main purpose is to facilitate and promote scientific dissemination.

Prerequisites

Make

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

$ choco install make

Docker

https://docs.docker.com/get-docker/

NPM

Just if you happen to use VSCode linter and formatter extensions Alternatively, using VSCode remote docker container extension might provide the same experience

https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

Local Environment

Setup and Running the app

$ make dev

Migrations are executed by default when the app is bootstrapping

Access

API

api.localhost

DB Admin

db.localhost

Teardown

$ make down-dv

Production Environment

Setup and Running the app

$ make prod

Access

api.universiteams.com

Teardown

$ make down-pd

Test

# unit tests
$ make test

# unit test [interactive debug mode]
$ make test-dg

# unit test coverage
$ make cov

# e2e tests
$ make e2e

# e2e tests [non-interactive debug mode]
$ make e2e-dg name="jest_test_partial_description"

Lint

make lint

Format

make format

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

About

Universiteams: Pro Scientific Dissemination

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages