Skip to content

Latest commit

 

History

History
139 lines (99 loc) · 4.07 KB

README.en.md

File metadata and controls

139 lines (99 loc) · 4.07 KB

E-Masjid.My

E-Masjid.My

Sistem masjid untuk semua

E-Masjid.My is a free and open source (MIT License) mosque management system


Live Demo


Philosophy

The main goals for this system are listed below.

Easy of use

  • Not everyone is an IT expert. Designing a system for non-IT people needs careful consideration.

Time to use your IT skills for good deeds

  • Open source is a form of sadaqah which is a required practice in Islam.

Longer living

  • Hosting/Tech companies may die, but we hope that by open-sourcing this project, it will live longer for the sake of ummah.

We give, not take

  • We should be contributing to the Muslim community, rather than benefiting from them, especially the Masjid.

Prerequisites

  1. Docker Desktop https://docs.docker.com/get-docker/
  2. Java 17 https://www.oracle.com/java/technologies/downloads/#java17
  3. Maven (binary) https://maven.apache.org/download.cgi
  4. Node 20 https://nodejs.org/en/download
  5. VSCode https://code.visualstudio.com/download
  6. GIT https://www.git-scm.com/downloads

Minimum Requirement for System Development

  1. Processor: 1.6 GHz or faster 64-bit processor
  2. Memory: 4 GB RAM or higher

Quickstart guide (Docker compose)

Fork this repo

  1. Fork this repo to your personal GitHub account, example https://github.com/<github-user>/e-masjid.my, by pressing the Fork button on the top right part of this page.
  2. Once done, clone this repo to your computer.
git clone https://github.com/<github-user>/e-masjid.my.git
  1. Once done, navigate to the e-masjid.my folder.
cd e-masjid.my
  1. Follow the instructions below depending on your computer's operating system.

Linux

sh run-dev.sh

Windows - Use Git Bash terminal in VSCode

sh run-dev.sh

This will automatically build all the APIs, and run the docker-compose file where it will spin up 6 containers for the developments environment.

Once the containers are up, you may stop any of the containers depending on what you will be working on to free up your local resources.

Gradle Build

You may utilise ./gradlew (or gradlew.bat on windows) provided to configure/execute your build. The commands below will show available tasks on gradle:

./gradlew task

./gradlew task --all

Gradle build for each backend modules

As seen in the output of the aforementioned ./gradlew task --all, you may execute builds separately for each of the backend modules. Each backend modules are written in Spring boot, so you may use org.springframework.boot plugin as below:

./gradlew api:tabung-api:bootRun --args='--spring.profiles.active=local'

You may also generate the Jar file separately for the use with docker-compose. Follow the step below to generate Jar:

./gradlew api:tabung-api:bootJar

The ultimateBuild

To facilitate the build for overall project, there is ultimateBuild. ultimateBuild can be triggered by:

./gradlew ultimateBuild

The ultimateBuild was written as such:

task ultimateBuild( type: Task,
        dependsOn: ["api:buildapi","dashboard:publish","public-web:publish"]
        ) {
    description="Build all programs"
    
    doLast {
        println  "build completed"
    }
}

Where:

  • api:buildapi builds all of the api projects, compile and package included.
  • dashboard:publish compiles the dashboard and render its distribution files.
  • public-web:publish compiles the public-web and render its distribution files.

Contributing guide

Please fork this repo and submit your Pull Request.

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Submitting a fix
  • Proposing new features
  • Enhancing features
  • Documentation
  • Unit testing

Or you would just like to chat with us, find us on Discord