Backend server for masjids.io
masjids.io is an all-in-one masjid technological, administration and management tool that enables masjids to easily establish an online footprint, and manage the services they offer through app integrations.
The current goal of masjids.io is to create a masjid administration tool, website management and hosting tool and a companion adhan app.
Limestone is the backend server for masjids.io which enables all of this functionality. It has (or will have) a user service with OAuth logins and SSO support, masjid registration, setting roles for different users for a masjid, role based authorization, website hosting and much more.
In order to run the server, you will need to install and be familiar with the following:
To regenerate protos, run cd proto, then run buf generate .. This MUST be done after each proto change.
To regenerate the Swagger YAML, run cd proto, then run buf generate .. This MUST be done after each proto change.
To create the `index.html`` file from the YAML file, first install redoc-cli via:
npm install -g redoc-cli
Then, run:
redoc-cli bundle -o docs/index.html docs/apidocs.swagger.yaml
To run the server, make sure the relevant environment variables are set; then, run the command:
go run server.go
from the root directory. This exposes both an HTTP server and a gRPC server. You can make calls to the gRPC server via grpcurl. But, for end-to-end testing, it's just easier to call the HTTP server, with any HTTP client (Postman or curl).
- User service
- Event service
- Masjid Service
- Adhan service
- gRPC Integration tests
- Nikkah Service API
- Reverts Service API
- JWT authentication
- HTTP integration tests
- Docker-ify server
- Setup github workflows to test and check for formatting, and push to prod
- Host container on Cloud
- Authorization service
- OAuth 2 SSO for providers like Google, Facebook, Microsoft, Apple.
- Custom website builder service and rendering server
- Adhan livestreaming API