Skip to content

Commit

Permalink
copy/paste main wiki page into README
Browse files Browse the repository at this point in the history
- Super mediocre README page to start.
- Somebody should replace this README!
- Main wiki page is here: https://github.com/politilounge/politilounge.github.io/wiki
  • Loading branch information
ckrailo committed Sep 11, 2018
1 parent 5ad3ade commit 1a3439c
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
@@ -1,2 +1,28 @@
# politex
Elixir Library wrapping Google Civic Information API

# Project Motivations
* [@ckrailo](https://github.com/ckrailo) and [@accua](https://github.com/accua) wanted a project to hack on while learning Elixir, but quickly realized that others could benefit from an open learning process as well.
* Now, we want to open the project and process up to others who want to learn as well or help mentor others.

# Project Goals
* Build API wrapper around [Google Civic Information API](https://developers.google.com/civic-information/). This is the [PolitEx library](https://github.com/politilounge/politex).
* Build Phoenix API and web frontends around the API consumed via the above wrapper. We haven't started this project repository yet.
* Blog where we post about our learning experiences.
* Wiki where we catalog links. (Perhaps similar to the [awesome lists](https://github.com/sindresorhus/awesome)?)
* Library documentation page at [politex.politilounge.com](http://politex.politilounge.com).
* Phoenix project code documentation page at TBD URL.

# API Wrapper
- Wrap [Google Civic Information API](https://developers.google.com/civic-information/).
- Expose all available endpoints and data. [API docs available here.](https://developers.google.com/civic-information/docs/v2/)

# Phoenix Project
- Details TBD, contributions and ideas are welcome.
- RestAPI endpoint for ???
- GraphQL endpoint for ???
- Web frontend for querying data from the [Google Civic Information API](https://developers.google.com/civic-information/).

# Collaboration
Please, come hack with us! This is our first Elixir project and first time trying out this open source learning project thing, so there's bound to be some mistakes. Learners and mentors should join the slack team below...
- Slack: [Elixir Slack Team](https://elixir-slackin.herokuapp.com/), channel: #politilounge

0 comments on commit 1a3439c

Please sign in to comment.