MagJob

MagJob is an application supporting work and communication in companies and organizations.

WARNING

• Please be aware that certain features may be unavailable or incomplete during this phase.
• Work is actively underway to finalize preliminary tasks and implement necessary security measures.

Documentation

Project Requirements and Use Cases

API Documentation (Swagger)

It is available at http://localhost:8080/swagger-ui/index.html#/ after starting the API

Run Locally

Clone the project

  git clone https://github.com/KeepIt-Up/MagJob.git

Run with Docker

Before you begin, ensure that you have the following tools installed on your system:

• Docker
• Maven
• Node.js

Go to the project directory

  cd MagJob

Run build.ps1 script

  ./build.ps1

Run docker-compose.yml with docker compose up

  docker-compose -f docker-compose.yml up  

Run Frontend App

Before running the MagJob Frontend locally, ensure you have the following prerequisites installed on your system:

• Node.js and npm - Download and Install Node.js
• Angular CLI - Install globally using npm:

  npm install -g @angular/cli

Go to the project directory

  cd magjob-frontend

Install dependencies

  npm install

Run the Angular Development Server

  ng serve

This will start the development server, and you can access the application at http://localhost:4200 in your web browser.

Run API

Before running the MagJob Backend locally, ensure you have the following prerequisites installed on your system:

• Java Development Kit (JDK) - Download and Install JDK
• Apache Maven - Download and Install Maven

Go to the project directory

  cd magjob-backend

Build the project

  mvn clean install

Run the Spring Boot Application

  java -jar target/MagJobBackendApplication.jar

Once the application is running, you can access it locally by navigating to http://localhost:8080 in your web browser.

Set Database

Before running the MagJob Backend locally, ensure you have the following prerequisites installed on your system:

• Postgress - Download and Install PostgreSQL

In pgAdmin do the following steps:

• Create role: (name: "admin", password: "admin", canLogin: true)
• Create database: (name: "postgres", Owner: admin) or only change the owner of the database

Roadmap

• Login and Registration
• Creating an Organization
• Inviting Members to the Organization
• Member Management
• Tasks with Chat for specific Roles and Organization Members
• Roles in the Organization
• Chats between Members of a given Organization
• Announcements for Organization

Authors

• @DamianLaczynski Team Leader, Product Owner, Frontend Developer
• @WallyS02 DevOps, Backend Developer
• @kmonieczny Backend Developer
• @szymon002 Backend Developer
• @Ekmoot13 Frontend Developer