Code Monkey home page Code Monkey logo

androiddevices's Introduction

Language MIT License

AndroidDevices

AndroidDevices is a website built in Vapor 2 that keeps track of all HomeKit accessories available in the market. Accessories are divided in 18 official categories to make it easier to find the perfect accessory for your needs. You can search any accessory by its name or manufacturer and directly open its official website to find more information.

Getting Started

To get started with AndroidDevices, make sure you have installed Vapor on your machine. Please follow the official guide. Make sure to also install PostreSQL since HomeKitty uses it as database. Postgres app should work fine.

Enough with the dependencies, clone the repo.

$ git clone https://github.com/RishabhTayal/AndroidDevices

You can now choose to build via command line, or use Xcode. Who doesn't love Xcode? ๐Ÿ› 

  • Terminal: vapor build && vapor run serve
  • Xcode: vapor xcode -y and then CMD+R.

Architecture

HomeKitty has a very simple architecture. The Sources folder contains two folders:

  • Run: contains main.swift and it's the starting point of the application.
  • App: contains all the controllers (route handlers), models and helper methods.

There are some basic tests in the Tests folder.

Contributing

We would love to have you onboard and help us shape the future of AndroidDevices. We have a ton of new features and bug fixes ready for you in the issues.

In case you need help or simply have a technical question, join us in the #development channel in our Slack.

Database

All accessories are stored in a PostgreSQL database. If you are interested in contributing with new accessories which are release everyday, let me know and we can try to find a solution and open them up to the community to improve the database.

During development, it's possible to seed the database with some example data for debugging purposes. Execute the seed.sh in the Scripts folder:

$ ./Scripts/seed.sh

Author

I'm Patrick Balestra. Email: [email protected] Twitter: @RishabhTayal.

Special thanks to @BalestraPatrick

License

AndroidDevices is available under the MIT license. See the LICENSE file for more info. Please don't re-publish the project as it is under your name. Feel free to use it a starting point for any of your other side projects though.

androiddevices's People

Contributors

balestrapatrick avatar rishabhtayal avatar

Watchers

 avatar

androiddevices's Issues

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.