sleddog / cards

Cards

The idea of this project is to build out a generic deck of cards and playing surface in order to play various games (texas holdem, wild card rummy, memory match, etc...).

Getting Started

• Clone the project to a local workspace of your choice. SSH Key method is reccomended.
• SSH: https://github.com/sleddog/cards.git
• HTTPS: [e-mail]:sleddog/cards.git
• 👉LEARN MORE about creating SSH keys in GitLab.

Prerequisites

Note: There currently are no dev or global depdencies for this project (it's just a simple HTML/JS project), so it theoretically can just be launched from a browser to view. (ex. open in browser: /users/me/myWorkspace/cards/index.html)

However, this project has been set up with package.json template for future development. This environment includes a simple local server to be able to run the project in a simulated dev environment.

If you decide to run the local server, the requirements are listed below. (Follow directions in #installing to lauch server)

node: >=8.1.3 npm: ^5.0.3 yarn: ^1.9.4

Installing and Running

From the root directory of the project... npm install -or- yarn

To serve... npm run serve then navigate to http://localhost:5000

Running the tests

@TODO There is currently no test suite set up

E-2-E & Unit tests

@TODO

And coding style tests

@TODO

Deployment

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

Built With

@TODO

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Devin Gray - Initial work - sleddog

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT license. See LICENSE for more info.

Acknowledgments

@TODO

• Hat tip to anyone whose code was used
• Inspiration
• etc