gsm

README

GSMArena API

GSMArena phone specification and finder. This project is still in early development.

The API basically reads from GSMArena website and results JSON data.

Requirements:

• Go 1.7.x or up
• GNU Make

Quick Start

# setup dependencies (you should run this once before compiling/running the app)
make setup

# compile and run the app
make serve

Available commands

Command              : Description
-------------------- : --------------------------------------------
make setup           : Install all necessary dependencies
make build           : Generate production build for current OS
make test            : Run tests
make serve           : Run the app locally
make image           : Create docker image
make run-image       : Run the app on docker
make clean           : Remove dependencies and compiled files

Implemented Features

• Get all brands
• Get devices by brand
• Get device specification
• Find devices by keyword
• Find devices by advanced filters

Online Demo

• Get all brands
• Get Samsung devices
• Get Samsung Galaxy S8 specification

Try on Local

• Using Postman

  

• Using Swagger UI

  This API doesn't have embedded Swagger UI. You may need to spawn Swagger UI docker container and use provided swagger.json file in this repo. Detail of setting up Swagger UI can be read from here.

---

Contribution

If you want to contribute code, please consider creating a pull request after forking this project.

If you have any questions, found bugs, or ideas, please open a ticket (issue).

---

Credits

• github.com/constabulary/gb
• github.com/PuerkitoBio/goquery
• github.com/fatih/color
• github.com/gorilla/mux
• github.com/justinas/alice
• github.com/rainycape/unidecode
• github.com/azer/snakecase

---

License

This project is licensed under the terms of the MIT license.