jgillham / impress

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

impress

Table of Contents

- [Description](#description) - [Features](#features) - [System Requirements](#system-requirements) - [Getting Started](#getting-started) - [Contributing](#contributing) - [Questions](#questions) - [Credits](#credits)

Description

Impress is a [Node.js](http://nodejs.org/) framework for real time micro bloggers. Users can post content and viewers can see that content propogate at the rate of instance messages. The framework is highly modular meaning that, although having recommended components, blogging services can elect to swap out a component for a prefered alternative. The framework uses RESTful API and the [MEAN stack](#mean-stack). Why impress?

We saw that the current web frameworks available today for microbloggers i. e. WordPress were monatomic, overly engineered , and did not support real-time micro blogging. Impress tries to find a modern solution to real-time micro blogging. Simply put, what would a platform like wordpress look like, had it been invented today using today’s web stack?

Impress is our take on real-time micro-blogging.

Features

- Modular. Web services may use the default web components or swap out for a prefered component.

- Small code base. The framework stays light via outsourcing components.

- Real time. Content posts propagate at the rate of instance messages.

- Modern. Uses RESTful API and the MEAN stack i.e. [MongoDB](http://www.mongodb.org/), [Express.js](http://expressjs.com/), [Angular.js](http://angularjs.org/), and [Node.js](http://nodejs.org/).

System Requirements

- [Node.js](http://nodejs.org/) - [MongoDB](http://www.mongodb.org/) - [Express.js](http://expressjs.com/) v3.1.0 - [Angular.js](http://angularjs.org/) - [Jade.js](http://jade-lang.com/) (latest version)

Getting Started

Start using the framework by cloning the repository and running the npm commands to grab dependencies. Use npm start to launch the server. Connect to [http://localhost:3000](http://localhost:3000) to view the page.

git clone https://github.com/dviramontes/impress.git
npm install -d
npm start

Contributing

1. Create an issue. 2. Fork the repository. 3. Fix the issue. 4. Create a pull request. Note: Use npm test to run all developement tests.

npm test

Questions

Have questions? Send us an email

Credits

Creator: [David Viramontes](https://github.com/dviramontes)

Team: [Joshua Gillham](https://github.com/jgillham), [Jesse Nelson](https://github.com/jnels124)

About


Languages

Language:JavaScript 90.3%Language:Shell 9.7%