Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zaimramlan/waktu-solat-api

Malaysia Waktu Solat JSON API (E-Solat API). Data from JAKIM's E-Solat.
https://github.com/zaimramlan/waktu-solat-api

e-solat-api json-api prayer-times ruby-on-rails waktu-solat-api

Last synced: 2 months ago
JSON representation

Malaysia Waktu Solat JSON API (E-Solat API). Data from JAKIM's E-Solat.

Awesome Lists containing this project

README

        

# Waktu Solat API

![](https://github.com/zaimramlan/waktu-solat-api/blob/master/docs/images/waktu-solat-api.png)

Malaysia prayer times (waktu solat) JSON API @ E-Solat API. Data from [JAKIM's E-Solat](http://www.e-solat.gov.my).

## Built with Waktu Solat API

[Waktu Solat Malaysia Telegram Bot](https://waktusolatbot.my) by [Zaim Ramlan](https://github.com/zaimramlan)

## About

- Built with Ruby (2.7.3) on Rails (5.2.5)
- First deployed on Heroku on midnight of 01 Feb 2017
- Data updates every midnight

## Documentation

[https://zaimramlan.github.io/waktu-solat-api/](https://zaimramlan.github.io/waktu-solat-api/)

## Endpoints

1. https://waktu-solat-api.herokuapp.com/api/v1/prayer_times.json
2. https://waktu-solat-api.herokuapp.com/api/v1/zones.json
3. https://waktu-solat-api.herokuapp.com/api/v1/states.json

## Future Improvements

- [ ] Pagination for `/prayer_times.json`

## Contributing

Do fork this project and improve where you see fit. Submit your Pull Request for merge review.
Use the [prepare repository](https://github.com/zaimramlan/waktu-solat-api#prepare-repository) section to help setup the repo on your local environment.

## Prepare Repository

Clone the repo and install the dependencies

``` bash
$ git clone https://github.com/zaimramlan/waktu-solat-api.git
$ cd waktu-solat-api
$ bundle install
```

Set up the database

``` bash
$ rake db:create db:migrate
```

Download the list of states, zones and prayer times

``` bash
$ rake esolat:v2:scrapezones esolat:v2:scrapetimes
```

Run the Server

``` bash
$ rails server
```

## License

- MIT