GithubHelp home page GithubHelp logo

i's Introduction

i

A simple microservice that serves you data about you.

๐Ÿค” What is this for?

A personal touch goes a long way in an online interactions, where things can feel disconnected or distant. This is meant to serve as a hub for personal data to which I can use to build personal interactions with on my projects.

โ“ How does this work?

Through the Shortcuts application on my iOS device, and other on-hand physical device integrations such as smart watches, IoT devices, and more, I'm able to send data to this API to which it can be readily served on projects.

Current iOS Shortcuts

You can install these on your own devices, and use this project as you please to build similar integrations. Most of these work well in automations which activate automatically, sans-prompt at sunrise, sunset, or at any point in the day.

  • Send Generalized Location
    • This template will allow you to send an API request to the /location endpoint with the generalized location information of the device it is run on.

Video Tutorials: Expand to View

Add Shortcut by URL
sqtU54u.mp4
Create Recurring Automation
CcJ2bTR.mp4

๐Ÿ”จ Configuration & Launch

Prerequisites

  • Docker
  • NodeJS
  • yarn

Configuration

First start off by cloning this repository.

git clone [email protected]:ridafkih/i.git

After that, navigate into the directory and install dependencies.

cd i
yarn

Once that's done, setup your .env file in the root directory according to the adjacent .env.example file.

Launch

Launching the project locally is easy, using Docker, Prisma, and NodeJS.

Start off by launching the database, and preparing the data schema. Make sure you have the Docker engine running for this part.

yarn database:up
yarn prisma:mix

Once that's done, run the data migrations.

yarn prisma:migrate:dev

Finally, you can run the microservice itself.

yarn dev

This will watch the directory for changes, so you can iterate quickly.

i's People

Contributors

ridafkih avatar

Stargazers

 avatar

Watchers

 avatar

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.