Giter VIP home page Giter VIP logo

uni-webdev-backend's Introduction

Project Okapi

Purpose

The goal of the project is to make an easy-to-use platform where students can track their time spent studying and completed tasks.

Authors

  • Maksim Usmanov (mausma)
  • Aleksandra Tremba (altrem)
  • Sten Smirnov (stsmir)

Technologies Used

  • Java 17+
  • Spring Boot 3.1.3
  • PostgreSQL
  • MapStruct 1.5.5
  • Liquibase 4.24.0
  • Lombok 1.18.30

Setup

Requirements

In order to get backend up and running, the system must have the following dependencies installed:

  • OpenJDK 17
  • Docker

Building

Note: Internet connectivity is required to download dependencies. Without it the source will not compile.

From the root of the source, run

./mvnw clean install spring-boot:repackage

After the task is completed, the backend-SNAPSHOT JAR file is created. In order to run it, open from the target folder and run:

java -jar *.jar

Database Configuration

When in root folder, using Docker Compose run the following command:

docker compose up -d

Now, your backend should be up and running with PostgreSQL as the database.

Features

Customer

  • Registers a user and saves his data in the database
  • Logs in the user, checks if the provided password is correct
  • Updates user data including when entering the correct password
  • Deletes a user
  • When requesting /{username}, gets public data (e.g. username, description, etc)

Tasks

  • Creates task with unique id and saves it in the database
  • Tasks have a name, description and status
  • Updates task with new name and description and saves the change in the database
  • Updates the status of the task
  • Deletes the task
  • Has a search by title
  • Has pagination
  • Has sort by status

Timer

  • Creates timer with unique id
  • Is connected to the customer via customer id
  • Starts timer and saves start time and end time in the database
  • Stops timer, calculating the remaining time before the end time
  • Updates the end time in database if the timer is continuing counting
  • Resets timer

Groups

  • Creates group with unique id
  • Is connected to the customer via customer id
  • Customers can be added to the group
  • Customers can be deleted from the group
  • Customer that created the group has an ADMIN role

Records

  • Displays amount of customers registered, timers started, groups and tasks created
  • Updates amount of users registered
  • Updates amount of timers started
  • Updates amount of groups and tasks created

uni-webdev-backend's People

Contributors

aleksandratremba avatar

Watchers

Max avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.