Carisurau.com (Formerly Ratemysurau.com)

About The Project

🔹 Lost in the mall? Can't find a surau nearby? Prayer time almost over? 🥲

🌐 Introducing Carisurau.com, the best solution to find surau wherever you are!

🕌 Discover nearby suraus and prayer rooms, ensuring you don't miss prayer time, even if you're in an unfamiliar place.

⭐️ Can't find the surau you want? You can make a difference by adding it to our platform! With just one click of the 'Add Surau' button, you can help others find their way to a place of prayer.

Built With

• Next.js
• TRPC
• AWS Lambda dan S3
• PostgreSQL

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Join us today and be part of this open source project that aims to make prayer accessible to all, everywhere.

Pre-requisites

• NodeJS 18 (you can use nvm)
• Docker
• make
• yarn
  • run corepack enable (Node.js >= 16.10)
  • run npm i -g corepack (Node.js < 16.10)
• Google Identity
  • Refer to our Wiki on how to setup your own google identity
• UploadThing

Installation

$ git clone git@github.com:farhan-helmy/ratemysurau.git

# Copy & update .env base on pre-requisite above
$ cp .env.example .env

$ yarn

# DB Setup
$ yarn db:setup
$ yarn db:migrate
$ yarn db:seed

$ yarn dev

Tests

We are using Vitest to test the application. You can use your knowledge on Jest into this as well.

https://vitest.dev/

# One time execution, useful for pipeline
$ yarn test

# Continuously watch changes on spec
$ yarn test:watch

Roadmap

• [ ] Add tests

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE.txt for more information.