gonzochic / inox

Social network feed using React and ES2015 with JSPM

INOX

This project is under development, we have no stable release at the moment :)

INOX is a social media plattform in a twitter like style to allow creative and innovative people to exchange their knowledge and get connected. The main ideas are:

• The portal is structured in feeds where users can contribute and talk about innovative topics. [in work]
• User can follow users, get updates and chat [pending]
• Users are able to search for certain topics [pending]

Version

0.0.1

Technology

INOX tries to use the current cutting edge technologies in both server and client side aspects.

• RESTful Backend Server with NodeJS
• Document-oriented database using MongoDB
• Reactive Frontend using ReactJS
• ES2015 (ES6) and JSX syntax which is transipiled with BabelJS and SystemJS
• JSPM is used as package manager and to bundle the ES2015 (ES6) Modules

Installation

You need a current version of NodeJS to be able to use this project.

As we're using JSPM as package manager you should install jspm globally:

$ npm install jspm -g

Then you can install the JSPM dependencies:

$ jspm install

Following with installing the Node Dependencies:

$ npm install

Now you can start the Backend Server which is also serving the client content:

$ node server.js

Configuration

We are using the dotenv module to set the environment. Simply create a .env file containing following variables:

• SECRET : Secret for the password encryption (default: enteryoursecrethere)
• DB_URL : Url to the MongoDB instance (default: mongodb://localhost:27017/inox)
• PORT : Port of the backend server (default: 8080)
• EMBEDLY_KEY: API Key for your Embedly Account (default: '')
• IN_PRODMODE: Pages will consume bundled React component. You have to create bundle to be able to use this mode (default: '0');

Generate test-data

When you are developing the project it might be useful the create some dummy test-data. We supplied you with a test-data generator:

$ node setupDB.js

Example

Here is an example of the current state of the project. Be aware that I'm not using https at the moment, so please use some kind of dummy password

License

Gnu GPL V2

inox's Issues

Use embedly to allow to post embedded content

It would be nice for users to be able to embed links into a post (like on facebook). For now I thought http://embed.ly should be the way to go.

Organize deployment

It should be able to deploy the software automatically. This means also do bundle the components and deploy a page to the user which uses the bundled javascript files.

Remove jquery dependency

We don't need it and it takes some time to fetch from the server. Remove it for example from the infinite scrolling logic of the entry list (see #10)

Display friends and their online status

In addition to #5 add a friendlist which displays their online status.

Add infinite scrolling

Instead of loading all the entries, add infinity scrolling

Add friendships

It should be possible to friend users

Add single-sign-on authentication for facebook, google and twitter

We should allow a single sign on with facebook, google or twitter accounts. Look at this tutorial: https://scotch.io/courses/easy-node-authentication

Add styling

At the moment there is only some plain bootstrap which styles the page. For the first release we should add a super fancy layout. Style matters ;).

Reload entries when posting

After refactoring the feed component is not able to reload entries after the post. Added a comment on the regarding line.

add a possibility to create and add avatars

There should be a possibility to create and display avatars which are displayed with the content of a user

Server side rendering

Instead of loading the initial data set on page load, we could speed things up be rendering the initial dataset on the server.

Add a chat

It should be possible to be able to chat i real-time with friends

Capture linebreaks from input

When using line breaks when creating comments the line breaks are not captured which results in a lost format when the entry is posted to the DB. It would also be super nice to support markdown.