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!
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.
git clone https://github.com/NathanHeffley/pointer.git
# install dependencies yarn
Now that you have the code downloaded, you should copy the
.env.example to create a
.env file. Add your public Pusher key (not your secret) and change the default cluster if your app uses a different location.
To start the dev server, simply run the
# serve with hot reload at localhost:8080 npm run dev
You will also need to run the lambda function which will handle connecting the users to the Pusher channel. Start it by using the
# run the lambda function ./node_modules/.bin/netlify-lambda serve src/functions
To build the static files and lambda function, simply run the
npm run build
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.
# run tests npm test
This project is licensed under the MIT License. See the LICENSE file for more details.