Code Monkey home page Code Monkey logo

slackit's Introduction

SlackIt

demo

Simple Slack lite clone for users to create teams and channels to collaborate via chat in real time.

Tech Stack


Getting Started

Dependencies needs to be installed from both directories. Run both of these commands from root directory. yarn can be replaced with npm i if using npm is preferred.

$ cd client && yarn
$ cd server && yarn

Install PostgreSQL and create a new database instance for this project. If psql isn't installed, follow installation guide.

$ psql
$ CREATE DATABASE 'database name';

Install Redis and make sure redis server is running. Redis installation.

Start redis server:

$ redis-server

Check if Redis is working by sending a PING command using redis-cli:

$ redis-cli ping

Redis will send a response if its working correct with:

PONG

Both client and server directories require a .env file. Rename .env.example to .env and fill out the remaining required environment variables to run this project.

In server directory, rename ormconfig-example.json to ormconfig.json to match the database config to your psql configurations for this project.

To run this project create a seperate terminal window and run both of these commands from root:

  • Replace yarn dev with npm run dev if using npm.
$ cd client && yarn dev
$ cd server && yarn dev

Future development

  • Responsive design for mobile
  • Batching sequel queries for more optimization
  • Private teams and channels
  • Document (PDF, DOC, etc) uploads (currently only supports images)
  • User status

slackit's People

Contributors

peterhangg avatar

Stargazers

 avatar

Watchers

James Cloos 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.