MessageBox Server

Server-Side application for sharing heartfelt messages
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This project serves as the web frontend for the MessageBox project. MessageBox allows you to easily send messages to friends or loved ones with a simple and easy to use interface. The messages are sent to the MessageBox hardware, and the user on the other end is notified of the new message. After opening the box and reading the message, the box clears it's screen and listens for more messages. This provides a clean interface to send personal messages to someone at work or home, without distracting the recipient or requiring them to use any complex technology.

Built With

• Rails 6

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You'll need the following:

• Ruby > 2.5

• PostgreSQL

• Node.js

• Yarn

• Ubuntu

sudo apt install ruby postgresql node yarn

• Arch

sudo pacman -S ruby postgresql node yarn

Installation

1. Clone the repo

git clone https://github.com/dburnsii/MessageboxServer.git

2. Install Rails

gem install bundle

3. Install dependencies

bundle install

4. Setup database

rails db:setup

Usage

To run the project, run the rails server:

rails s

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Desone Burns II - dburnsii@live.com

Project Link: https://github.com/dburnsii/MessageboxServer