Skip to content

bmds/SlackXWingCardCmd

Repository files navigation

X-wing slack card command

This repo provides a very simple implementation of a slack command that returns details of upgrade cards for the Fantasy Flight X-Wing game within Slack.

Usage

The script hosts a single endpoint for Slack to access. It returns JSON with the result of the card search.

Commands

A basic search is performed with /card $ which will search using the term contained within $. A filtered search can be performed with /card $1 ($2) where $1 will be the search term and $2 will be the card type to use.

Dependencies

All of the data for the cards is imported from: X-Wing Data The service uses : X-Wing Data

Local dev

All but one of the environment variables are stored in a .env file in the root of the project. You will need to create this yourself or get it from someone else on the project. The structure of the file is as follows:

PROJECT_ID=some-id
KEY_ID=blahblahkey
[email protected]
CLIENT_ID=123456789
PORT=1234

The additional variable is for the private key as Heroku local doesn't currently support multiline vars. You will need to export this manually. On OS X a demo bash script can be found in tools/env.demo.sh.

To run the site locally use the command heroku local, this will use the local variables set in .env and run the site.

Testing

The project is tested using AVA, to run the tests use npm test.

Deployment

Make sure that the correct environment variables are set in the Heroku environment you are deploying to then use git push heroku master to deploy to Heroku.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published