pointer

My open-source pointing poker application.

Work In Progress

This project is still under development. Check out the issues and projects to see if there's anything you're interested in helping out with!

Getting Started

Prerequisites

Pointer uses Pusher, specifically their presence channels, to handle communication between clients. This means you'll need to go to Pusher and create an application that you can use for this project.

Installing

To get started, you'll need to clone the repo and install its dependencies. These examples will use Yarn since that is the maintained lock file, although npm should work just as well.

yarn install

Now that you have the code installed, you should copy the .env.example to create a .env.local file. Add your public Pusher key and change the default cluster if your app uses a different location.

Development

To start the dev server on localhost:8080, simply run the serve command.

yarn serve

You will also need to run the lambda function which will handle connecting the users to the Pusher channel. Start it by using the `netlify-lambda' command.

./node_modules/.bin/netlify-lambda serve src/functions

Building

To build the static files and lambda function, simply run the build command.

yarn build

Testing

All new code for the project should be accompanied by reasonable tests. The only exception for this right now is code that directly interacts with Pusher, in which case steps for manually testing the feature should be included in your PR.

yarn test:unit

License

This project is licensed under the MIT License. See the LICENSE file for more details.