RocketChat/Rocket.Chat.Apps-dev-environment

Name: Rocket.Chat.Apps-dev-environment

Owner: Rocket.Chat

Description: The Rocket.Chat Apps development environment.

Created: 2017-06-19 16:26:50.0

Updated: 2018-05-15 23:56:51.0

Pushed: 2018-05-20 20:35:11.0

Homepage:

Size: 1410

Language: HTML

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Rocket.Chat Apps Development Environment

Development environment for getting started developing Rocket.Chat Apps.

Getting Started

Extremely simple.

clone git@github.com:RocketChat/Rocket.Chat.Apps-dev-environment.git
install
start

This will watch the apps directory for changes and run everything.

Environment Layout Explained

In trying to make this a smooth development environment there were a few decisions made. First up, unless you're extending the development environment, the only folder you should be concerned about is apps and dist. The other folders are for making the development environment a pleasure to work with (hopefully). The .server directory is the “mock” server with storage, this is where the code lives which mocks up the Rocket.Chat server.

Generating an App ID

We require UUID Version 4 for IDs. To generate one for your App we recommend this site: https://www.uuidgenerator.net/version4

Logging Inside an App

Due to limitations of NodeJS's vm package we have had to implement a custom logger class. To make usage of this you can use this.getLogger() and then do the normal console style logging.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.