https://github.com/laurabeatris/pokecards
cards game for terminal to have fun playing with pokemons in a simple way
https://github.com/laurabeatris/pokecards
backend elixir elixir-lang
Last synced: 12 months ago
JSON representation
cards game for terminal to have fun playing with pokemons in a simple way
- Host: GitHub
- URL: https://github.com/laurabeatris/pokecards
- Owner: LauraBeatris
- License: mit
- Created: 2020-06-17T12:24:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-10T13:27:12.000Z (almost 6 years ago)
- Last Synced: 2025-03-17T05:35:00.245Z (over 1 year ago)
- Topics: backend, elixir, elixir-lang
- Language: Elixir
- Homepage:
- Size: 401 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Pokecards
> Cards game for terminal to have fun playing with pokemons in a simple way.
[](https://github.com/LauraBeatris)
[](#)
[](https://github.com/LauraBeatris/pokecards/stargazers)
[](https://github.com/LauraBeatris/pokecards/network/members)
[](https://github.com/LauraBeatris/pokecards/graphs/contributors)
---
# :pushpin: Table of Contents
* [Installation](#construction_worker-installation)
* [Getting Started](#runner-getting-started)
* [Documentation](#book-documentation)
* [FAQ](#postbox-faq)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
# :construction_worker: Installation
**You need to install [Elixir](https://elixir-lang.org/install.html) first, then in order to clone the project via HTTPS, run this command:**
```
git clone https://github.com/LauraBeatris/pokecards.git
```
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:
```
git clone git@github.com:LauraBeatris/pokecards.git
```
# :runner: Getting Started
Run the following command in order to start the Interactive Elixir Shell
```
iex -S mix
```
# :book: Documentation
In order to explore the functions and module details, go to the [Documentation Page](https://laurabeatris.github.io/pokecards/Pokecards.html)
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the [Pokecards](https://github.com/LauraBeatris/pokecards/issues) repository. If you already found a solution to your problem, **i would love to review your pull request**! Have a look at our [contribution guidelines](https://github.com/LauraBeatris/paypal-clone/blob/master/CONTRIBUTING.md) to find out about the coding standards.
# :tada: Contributing
Check out the [contributing](https://github.com/LauraBeatris/pokecards/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
Documention and application under development.
Released in 2020.
This project is under the [MIT license](https://github.com/LauraBeatris/pokecards/master/LICENSE).
Made with love by [Laura Beatris](https://github.com/LauraBeatris) 💜🚀