https://github.com/alpcanaydin/githubist-api

API repository for Github.ist
https://github.com/alpcanaydin/githubist-api

data-visualization github statistics turkey

Last synced: 7 days ago
JSON representation

API repository for Github.ist

• Host: GitHub
• URL: https://github.com/alpcanaydin/githubist-api
• Owner: alpcanaydin
• License: mit
• Created: 2018-10-12T20:55:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-24T18:07:58.000Z (almost 6 years ago)
• Last Synced: 2023-03-03T13:17:14.438Z (almost 2 years ago)
• Topics: data-visualization, github, statistics, turkey
• Language: Elixir
• Homepage: https://github.ist
• Size: 67.4 KB
• Stars: 37
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Github.ist API

This is the API repo for https://github.ist. You may also want to take a look to [Web](https://github.com/alpcanaydin/githubist) and [Fetcher](https://github.com/alpcanaydin/githubist-fetcher)

## Installation

Before the installation, please provide the seed data via [Fetcher](https://github.com/alpcanaydin/githubist-fetcher). You can find the instructions in the fetcher repo.

### Docker

- Install dependencies with `./mix deps.get`

- Create and migrate your database with `./mix ecto.create && ./mix ecto.migrate`

- Seed the database with `./mix run priv/repo/seeds.exs`

#### Executing Custom Commands

To run commands other than mix tasks, you can use the `./run` script.

`./run iex -S mix`

### Traditional Setup

- Change directory to src with `cd src/`

- Install dependencies with `mix deps.get`

- Create and migrate your database with `mix ecto.create && mix ecto.migrate`

- Seed the database with `mix run priv/repo/seeds.exs`

# Starting the API

You can start the API with `mix phx.server` command. You can visit [`http://0.0.0.0:4000`](http://0.0.0.0:4000) from your browser.

## Wıth Docker

You can start the API with `docker-compose up`. You can check it via `curl 'http://localhost:4000/graphql' -H 'content-type: application/json' --data-binary '{"operationName":null,"variables":{"username":"mdegis"},"query":"query ($username: String!) {\n  developer(username: $username) {\n    ...BasicDeveloper\n    bio\n    githubUrl\n    __typename\n  }\n}\n\nfragment BasicDeveloper on Developer {\n  id\n  name\n  username\n  avatarUrl\n  __typename\n}\n"}'`