Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.42 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.42 KB
Raw

alfred

An Internet-of-Things smart mirror built with JavaScript and Raspberry Pi - works with a client-side dashboard which pushes directly to the mirror display.

The App is on Heroku

It is recommended to use the deployed version of this app so you don't have to constantly run a local server. However, an installation guide for a local server is included below.

Installation to Run Locally

Git clone this repo and install all dependencies:

git clone https://github.com/alfred-mirror/alfred.git
cd alfred
npm install

This Alfred server saves the user's config settings into a Mongo database which you also need to start up locally (make sure you have MongoDB installed on your device).

mkdir db
mongod --dbpath=./db --smallfiles

Then start the server.

node server.js

Make sure both the client dashboard and the mirror display's servers are also running. The entire app should be now working on the client dashboard's specified port or defaults to localhost:3000.

Issues? Suggestions? Comments?

Submit an issue on GitHub.

License

MIT Licensed. For more details, see the LICENSE file.