Skip to content

nei-estg/nei-website

Repository files navigation

NEI Website

Welcome to the NEI-ESTG website! This project aims to provide various features for students, including a blog with relevant news, a calendar of exams, open classes, and other events, materials for all curricular units, and the ability to mentor or be mentored by another student in a curricular unit.

Overview

This website serves as a centralized platform for ESTG IT students to access important information, resources, and opportunities within their academic community.

Technologies Used

  • Docker
  • TypeScript
  • React
  • Material-UI
  • Django
  • Prometheus
  • Grafana
  • NGINX

Prerequisites

  • Docker

Getting Started

  1. Install Docker and VSCode
  2. Make sure you have Docker Compose (docker-compose)
  3. Create your own .env file in the root directory based on the .env.example file and adjust the values 3.1. For the Django Secret you can use this website: Djecrety 3.2. Define the database name, user and password with your own values (won't be shared)
  4. Run Docker Compose 4.1 Learn how to use VSCode Tasks here. (CTRL+SHIFT+P -> Run Task) 4.2. One alternative is to use the terminal and run docker-compose up --build

🚀 Running the Project

  1. Access the frontend at http://127.0.0.1/
  2. Access the backend at http://127.0.0.1/api/nei

Features

  1. Blog: Stay updated with relevant news and announcements for ESTG IT students.

  2. Calendar: Keep track of exams, open classes, and other events relevant to your academic schedule.

  3. Curricular Materials: Access materials for all curricular units to aid in your studies.

  4. Mentorship: Participate in mentorship programs where you can either mentor or be mentored by another student in a curricular unit.

🤝 Contributors

Made with ☕ and 💜 by NEI's Web Development Team:

Foto da Alice Dias no GitHub
Alice Dias
Foto do João Oliveira no GitHub
João Oliveira
Foto do Miguel no GitHub
Miguel
Foto do Leandro Magalhães no GitHub
Leandro Magalhães