My Coffee Table is a Single Page Web application that allows users to have a virtual desktop or coffeetable to place elements on.
These elements can be links to websites, iframes to have embeded content appear such as Youtube videos, images and notes.
Before you begin, ensure you have met the following requirements:
- You have installed the bundle required version of ruby
- You have a Linux/Mac(Unix) machine.
To install my_coffee_table, follow these steps:
Linux and macOS:
cd backend & bundle install & rails s
To use my_coffee_table, follow these steps:
open frontend/index.html
To contribute to my_coffee_table, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin my_coffee_table/<location>
- Create the pull request.
Alternatively see the GitHub documentation on creating a pull request.
If you want to contact me you can reach me at [email protected]
This project uses the following license: MIT License.