Git Product home page Git Product logo

ays-be's Introduction

AYS | Afet Yönetim Sistemi API Application Status

Description

Disaster Management System ,which is named as AYS(AFET YÖNETİM SİSTEMİ), is an open source and voluntary project. The aim is to manage the needs that arise during a natural disaster. It manages the coordination of the need processes between volunteers and institutions in the disaster area.

This project is designed to be used by non-governmental organizations and volunteers of related organizations. Organizations and the volunteers to be registered by the organizations, the needs in the disaster area, volunteers who are close to the relevant region and need, aims to manage the needs quickly and accurately.

Processes

  • Institute (Institution) user Processes : It is aimed to ensure resource management of the organization in case of a disaster and to carry out these processes according to the relevant scenarios. It allocates workloads for volunteers according to the needs and follows up.

  • Admin : The role of Admin takes part in the management of users and institutions that voluntarily participate in the role. It follows up institutions and users.

  • User : It represents the users who are in the relevant disaster area and want to take part in disaster processes voluntarily. Users who want to participate voluntarily can contact the relevant organizations for the needs in their region. can be automatically assigned, or interested volunteers can choose from the needs in their region select the most appropriate assignment and complete the relevant process.

Tech Stack

Framework

  • Core
    • Spring
      • Spring Boot 3
      • Spring Boot Test (Junit)
      • Spring Boot Dev Tools
      • Spring Web
      • Spring Boot Actuator
      • Spring Doc Open API
      • Spring Security 6
      • Spring OAuth2 Client
      • Spring OAuth2 Resource Server
    • Spring Data
      • Spring Data JPA

3rd Party Dependencies

  • Lombok
  • Test Containers
  • Mapstruct
  • Easy Random
  • JSON Web Token
  • JSON Web Signature
  • Bouncy Castle

Database

  • MySQL

Database Migration Tool

  • Liquibase

Language

  • Java 17

Build Tool

  • Maven

Software Development Process

  • TDD
  • Agile Kanban
  • Jira

Version Control

  • Git
  • GitHub

APIs Interaction Platform

  • Postman

Application Pipeline

  • GitHub Actions


Getting Started


The project has been generated by Spring Initializer.

Instructions Before Building Project

First of all, generate personal access token with this url : https://github.com/settings/tokens

Before Running Locally On IDE

  1. If you have ~/m2/settings.xml file in your computer, skip the step without reading the after section. If you aren't using the ~/.m2/settings.xml file to actively, you can be back up it before creating the new settings.xml file, if you want. If you are using actively, after the perform step 3 you can manually merge the settings.xml file in the project with the ~/.m2/settings.xml file and skip step 2 and 4.
  2. While inside the project directory in the terminal; that is, when you are in the ~/afet-yonetim-sistemi/ays-be directory, run the command cp template-settings.xml settings.xml.
  3. In the settings.xml file within the project, replace the {YOUR_GITHUB_USERNAME} placeholder with your GitHub username and replace {YOUR_PERSONAL_GITHUB_ACCESS_TOKEN} with the access token value you created on GitHub as described in the instructions under the 'Instructions Before Building The Project' section.
  4. If the .m2 directory has not been created before, you can use the command mkdir ~/.m2 and then run the command cp settings.xml ~/.m2/settings.xml for copy the settings.xml file located in the project to the ~/.m2 directory.

Don't forget to enable Lombok pre-processing in your IDE!

Building The Project With Tests

./mvnw clean install

Building The Project Without Tests

./mvnw clean install -DskipTests

Running as Docker MySQL container

Before running the project, you need to run the following command to start the MySQL container:

docker compose up -d --build database

If you want to recreate the MySQL container, you can run the following command:

docker compose up --force-recreate -d --build database

If you want to stop the MySQL container, you can run the following command:

docker compose down -v database

Running As Docker Container

  1. While inside the project directory in the terminal; that is, when you are in the ~/afet-yonetim-sistemi/ays-be directory, run the command cp template-settings.xml settings.xml.
  2. In the settings.xml file within the project, replace the {YOUR_GITHUB_USERNAME} placeholder with your GitHub username and replace {YOUR_PERSONAL_GITHUB_ACCESS_TOKEN} with the access token value you created on GitHub as described in the instructions under the 'Instructions Before Building The Project' section.

Before running the project, you need to run the following command to start the project container:

docker compose up -d --build

If you want to recreate the project container, you can run the following command:

docker compose up --force-recreate -d --build 

If you want to stop the project container, you can run the following command:

docker compose down -v 


The project is managed by Jira. You can assign an issue from the Todo list and start working on it.


Project Documents

For other information, you can check Confluence Page.


Postman

AYS Local Environments

AYS APIs



Project Infrastucture

ays-be's People

Contributors

agitrubard avatar ahmetaksunger avatar rapter1990 avatar ibrahimdenizz avatar halilturkoglucs avatar ilkercelimli avatar anilhazar avatar emreylmaz avatar artfulcoder98 avatar moaydogdu avatar thelastbadalov avatar sarpkan00 avatar mehmetseymusyuzen avatar skayikci 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.