Automaid is a IoT application, allowing users to keep track of home devices, as well as create automations for them. Automaid is Ruby on Rails application.
Users can access Automaid by cloning this repository.
-
Scroll up and find the green "Code" button:
-
Click it, and a tab should drop down including a github link (make sure to select the one under SSH).
-
Manually copy or click the clipboard icon to copy the link.
-
In the user terminal enter 'git clone':
user@Users-MacBook_Air % git clone [paste link]
- Navigate to the Automaid file.
user@Users-MacBook_Air Automaid %
- Run 'bundle install' and 'rails db:migrate' in your terminal:
user@Users-MacBook_Air Automaid % bundle install
user@Users-MacBook_Air Automaid % rails db:migrate
- Once inside Automaid run the program by typing 'rails s' in your terminal:
user@Users-MacBook_Air Automaid % rails s
- Finally click on the link following '* Listening on':
* Listening on http://localhost:3000/
(run CTRL+C to exit)
Congrats 🎉 you can now log all your home devices!
Since this application was primarily made for educational purposes, anyone is welcome to contribute. Make sure any pull requests have meaningfully commit messages that accurately and completely describe any changes. Do not include any changes that are not in the commit message.
Bug reports and pull requests are welcome on GitHub at https://github.com/mmeurer00/Automaid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Everyone interacting in the Automaid project’s codebases, issue trackers, posts and users are expected to follow the code of conduct.