Skip to content

maumercado/server-side-events-react

Repository files navigation

MauGGer

A simple clone of Segment's event debugger.

TODO:

There is an existing set of tests for reducers and actions for the client application, however adding more tests, specially integration tests should be more meaningful.

  • Add more automated tests for both client and server

Installation and Getting started

Install bunyan with npm install -g bunyan so you can pipe logs on the terminal like npm run server | bunyan -o short

Installation and execution with Docker

You can download the image for this project by simply doing docker pull maumercado/debugger, note that the port exposed is 4000.

You can also git clone this project and simply run docker-compose up from the root directory, as you can see the docker-compose.yml file contains 3 different images, a redis image which is used as a pub/sub for "events", an event creator or stream image, which is the publisher of "events", and of course the debugger which acts as the subscriber for receiving "events".

Manual Installation and execution

git clone git@github.com/maumercado/server-side-events-react.git
cd debugger-maumercado
npm install-all
npm run server

Now go to http://localhost:4000/ you should see a running version of the debugger

Running the tests

Simply run npm run test, for now it will simply run a couple of tests for the API, testing that is up, and it replies with a 200 for the /ping endpoint. As for the client side it tests that App.js or the initial point of the client side of this application renders correctly.

Deployment

Add additional notes about how to deploy this on a live system

Built With

Authors

License

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

Acknowledgments

  • Thanks to anyone whose code was used

About

A project with server side events sent to a React app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages