GSMArena phone specification and finder. This project is still in early development.
The API basically reads from GSMArena website and results JSON data.
# setup dependencies (you should run this once before compiling/running the app)
make setup
# compile and run the app
make serve
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
- Get all brands
- Get devices by brand
- Get device specification
- Find devices by keyword
- Find devices by advanced filters
-
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.
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).
- 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
This project is licensed under the terms of the MIT license.