Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 2.81 KB

README.en.md

File metadata and controls

92 lines (61 loc) · 2.81 KB

my Github forks Github issues Github last-commit

E-Masjid.My

E-Masjid.My

Sistem masjid untuk semua

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



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. GIT https://www.git-scm.com/downloads
  2. Docker Desktop https://docs.docker.com/get-docker/
  3. Node 20 https://nodejs.org/en/download
  4. Go https://go.dev/dl/
  5. VSCode https://code.visualstudio.com/download

Minimum Requirement for System Development

  1. Processor: 1.6 GHz or faster 64-bit processor
  2. Memory: 8 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.
docker compose up -d

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.

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