andysylvester/MyStatusToolDemo

My Status Tool Demo

View a demo of the MyStatusTool app!

View Demo App · Report Bug · Request Feature

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Customizing The App
Contributing
License
Contact
Acknowledgments

About The Project

My Status Tool is an application that provides the basic posting and reading functionality within Twitter, but using RSS and rssCloud as the enabling technologies.

The basic functions are:

Ability to make a short post
When a post is made, a RSS feed is updated, a separate page for the post is created, and the post appears on the home page via Websockets
The tool provides hosting for the RSS feed and posts created
The tool can display updates to any RSS feeds that support the rssCloud protocol via Websockets

The tool is set up for a single user and requires some configuration. Please consult the Installation section in this README file for more information.

This app is a proof of concept, but will be further developed. If you find problems in the tool, or want to suggest features, feel free to create an issue in the Github repo.

(back to top)

Built With

(back to top)

Getting Started

Here is how to get your copy of the app running!

Prerequisites

Node.js install (needs to be on a server on the Internet)
NPM install
Git (optional, but can be helpful on the install)

Installation

Clone the repo if you have Git installed
```
git clone https://github.com/andysylvester/MyStatusToolDemo.git
```
This will create a folder called MyStatusToolDemo
If you do not have Git installed, you can download a copy of the app as a Zip file, then unzip the app into a folder called "MyStatusToolDemo" on your computer/server.
In a terminal window, install the required NPM packages by changing directory to the install folder, then type the following command:
```
npm install
```
The app uses a configuration file to set parameters needed for the app and for creating the RSS feed. The default parameters are for the demo app, this file should be updated for the parameters for the server where the app runs.

(back to top)

Starting The App

To start the app, enter the following command in a terminal window in the app folder:

   node app.js

The app will start on port 443 by default. Open a tab in a web browser and enter the URL of the server with ":443" at the end of the URL (or the port specified in the config.json file). The app will read the RSS feeds listed in the config.json file and display their current content.

To use the app, enter some text in the text field at the top of the window and click the button. The post will appear below the "Subscribed feeds" area, the RSS feed will be updated, and a page will be created for the new post. You can click on the RSS Feed item in the menu bar to see the list of items.

Again, you should see the app running as in the screenshot shown earlier on this page.

You can see the app running here and give it a try! Also, feel free to install a copy on a server yourself!

Customizing The App

The main app is mostly an auto-generated Express application, so other Express features can be added.

Embedded Javascript templates are used for the creation of the pages, the Bootstrap toolkit is also used for formatting.

The app currently runs on port 443, this can be changed by editing the configuration file. However, if a port other than 443 or 80 is used for the app, updates to RSS feeds from WordPress.com sites will not be received.

You can use the NPM package forever to keep the app running continuously. To install the package, type the following command in a terminal window on your server:

   sudo npm install forever -g

Once you have installed the forever package, use the following command to start the app:

   forever start app.js

To stop the forever process, type the following in the app directory:

   forever stopall

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!