Giter Club home page Giter Club logo

gsm's Introduction

Build Status

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:

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

Try on Local

  • Using Postman

    Run in 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


License

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.