Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbta/parking_tweets
Tweets about parking garage availability
https://github.com/mbta/parking_tweets
Last synced: about 1 month ago
JSON representation
Tweets about parking garage availability
- Host: GitHub
- URL: https://github.com/mbta/parking_tweets
- Owner: mbta
- License: mit
- Created: 2018-05-25T18:57:18.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-03-03T17:57:32.000Z (almost 2 years ago)
- Last Synced: 2023-03-11T00:53:38.628Z (almost 2 years ago)
- Language: Elixir
- Homepage:
- Size: 134 KB
- Stars: 2
- Watchers: 12
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ParkingTweets
Tweets about parking garage availability.
[](https://github.com/mbta/parking_tweets/actions/workflows/elixir.yml)
## Configuration
ParkingTweets requires 5 environment variables:
- `API_KEY`: a [V3 API](https://api-v3.mbta.com/) key
- `CONSUMER_KEY`
- `CONSUMER_SECRET`
- `ACCESS_TOKEN`
- `ACCESS_TOKEN_SECRET` - configuration variables from [Twitter](https://developer.twitter.com/)
## Running the applicaion
You can run the application on your local machine:
```
mix run --no-halt
```
Or with Docker:
```bash
docker build . -t parking_tweets
docker run parking_tweets
```
## Development Setup
```
# after installing asdf from https://github.com/asdf-vm/asdf..
asdf install
# get Elixir dependencies
mix deps.get
# add pre-commit hook to verify formatting & tests
ln -s ../../hooks/pre-commit .git/hooks/pre-commit
# make sure everything passes! (slowest to fastest)
mix format --check-formatted
mix credo
mix test
# you can also run them in Docker
docker build -f Dockerfile.test .
```
## License
ParkingTweets is licensed under the [MIT license](LICENSE).
## Code of Conduct
Parking Tweets is governed by the [Contributor Covenant](CODE_OF_CONDUCT.md), version 1.4.