/weedstoned

🔖 Programatically creates digital trading card games with customized templates.

Primary LanguageJavaScriptMIT LicenseMIT

WeedStoned: Programatically Create a Trading Card Game

Welcome to WeedStoned.

An easy-to-use solution to your trading card game needs. Firstly, implemented along with the React.js framework, you can define everything. Lastly, you can also use our own. We offer both solutions and all the essential tools that you need in order to programatically construct a TCG-based application. Please, follow along the next sections in order to learn more about this excellent tool.

WeedStoned is compatible with the latest: React.js.


Package guidelines

  1. The very first information you need is in the very next section.
  2. Installing is also easy if you wish to read the code and bump yourself into, follow along.
  3. Note that there might be some additional steps in order to use our solutions.
  4. If there is a problem, please do not hesitate, call us.

Getting started: 60 seconds with WeedStoned

First of all. Code is all commented. Yes, they are commented. Just browse to any file, chose your subpackage, and follow it. We have high-level code for most tasks we could think of.

Alternatively, if you wish to learn even more, please take a minute:

WeedStoned is based on the following structure, and you should pay attention to its tree:

- weedstoned
    - public
    - src
        - assets
        - components
        - data
        - utils
        - views
        - App.js
        - App.scss
        - Routes.js
        - index.js

Public

This folder holds all the base public files that will be further generated and served. Only use if you need to change the favicon or configure any relevant header that must be present on HTML files.

Source

Known as src, this is where all the magic happens. Follow along the next items to understand what is happening here.

assets

External assets should be created and used here. We will be using SCSS as your pre-processor for CSS files. You can also add here static images if needed.

components

Every component should be placed here. An intelligent application uses a trade-off between when componentization should happen or not. For layout-related components, we assume this is a must.

data

These are data objects that feeds the components. For example, you might want to change what use your own TCG instead of WeedStoned.

utils

Utilities should be placed and loaded here. We encapsulate some common definitions so they can be used throughout the whole project.

views

Views are the "face" of your application. Essentially, they are a bunch of components, assume a route and perform in a particular way inside the application.


Installation

We believe that everything has to be easy. Not tricky or daunting, WeedStoned will be the one-to-go package that you will need, from the very first installation to the daily-tasks implementing needs.

Development

First of all, make sure that you have a Node.js environment installed, allowing the access to npmor yarn commands.

Next, install the needed requirements by performing the following commands:

npm install | yarn install

Finally, you can start the development service:

npm start | yarn start

All bootstrap commands were pre-loaded when this package was created. We have strictly followed the Create React App.


Environment configuration

Note that sometimes, there is a need for additional implementation. If needed, from here you will be the one to know all of its details.

Ubuntu

No specific additional commands needed.

Windows

No specific additional commands needed.

MacOS

No specific additional commands needed.


Support

We know that we do our best, but it is inevitable to acknowledge that we make mistakes. If you ever need to report a bug, report a problem, talk to us, please do so! We will be available at our bests at this repository.