Giter Club home page Giter Club logo

chat's Introduction

Nyao - the open-source chat application for developers

CircleCI Build Status Dependency Status Codecov

Getting started

Docker (quickest)

It is taken for granted that you have both Docker and Docker Compose.

docker-compose up

or

docker-compose run --service-ports web npm start

Other execution options.

Node

Requirements:

npm install

Start MongoDB & Redis: (skip this step if you have them running already)

scripts/startdb.sh

Run the project (see Execution for alternative options):

npm start

Execution

Default (production):

npm start

Production (backend only):

npm run start-prod-backend

Production (frontend only):

npm run start-prod-frontend

Development:

npm run start-dev

Development (backend only):

npm run start-dev-backend

Production (frontend only):

npm run start-dev-frontend

Docker

When using Docker, npm commands can be passed by overriding the default web command:

docker-compose run --service-ports web npm start

Production

Production Docker Compose gathers the latest version from the Docker Hub.

docker-compose -f docker-compose.yml -f docker-compose.prod.yml up

Configuration

The default configuration file resides in config/default.js. You can create your own configuration files that extend it that suit your own needs (configuration files are based on config).

To start, you should be creating a config/production.js or config/development.js, for development or production respectively, that looks like the following:

module.exports = {
  passport: {
    github: {
      clientID: 'Github client ID',
      clientSecret: 'GitHub secret key',
      callbackURL: 'http://mydomain:3000/api/auth/github/callback',
    },
    google: {
      clientID: 'Google client ID',
      clientSecret: 'Google secret key',
      callbackURL: 'http://mydomain:3000/api/auth/google/callback',
    },
  },
}

Development

Folder structure

.
├── backend
├── config
├── data
|    ├── db-data
|    └── db-session
├── docs
├── frontend
├── public
├── scripts
├── webpack
├── .babelrc
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .package.json
├── .travis.yml
└── README.md

chat's People

Contributors

zurfyx avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  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.