Giter VIP home page Giter VIP logo

holocron's Introduction

Holocron

An Angular 2 material design socket.io chat application

Features

  • Unique nicknames
  • Rooms with instant messaging
    • Can view the entire chat history of the room
  • Create and join rooms
  • Op, deop, kick and ban users in your room
  • Private messages
    • Private message history with everyone you've messaged to
  • Toast notifications
  • Beautiful UI

Getting Started

In order to run Holocron on your own machine, you will need node.js in order to use npm to install the dependencies and run the server.

Prerequisites

Angular-CLI

Run the following command in order to start up the client.

$ sudo npm install -g angular-cli

Dependencies

Run the following command in the Holocron/src/client/ and Holocron/src/server/ folders.

$ npm install

Running the server

You start up the server by running chatserver.js, located in the Holocron/src/server/ directory, with node. From the root directory of the project run the following command in your CLI.

$ node src/server/chatserver.js

Now the server is up and running on port 8080 by default.

Starting up the client

You start up the client by using angular-cli From the client folder of the project (Holocron/src/client/) run the following command in your CLI.

$ ng serve

Wait a bit while it starts up and afterwards the client is accessible via localhost:4200

Development

We use the Angular-CLI as our build system which has webpack at it's core.

We also use Gulp to enforce our TypeScript coding rules.

Built With

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

holocron's People

Contributors

indexu avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.