├── .env.example
├── .github
└── workflows
│ └── tests.yml
├── .gitignore
├── .gitpod.yml
├── BATTLESTAX.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── astra.json
├── env.sh
├── functions
├── helloWorld.js
└── insertGame.js
├── hero.png
├── netlify.toml
├── package.json
├── public
├── favicon.ico
├── index.html
├── placeholder.png
└── robots.txt
├── src
├── components
│ └── App
│ │ ├── App.js
│ │ ├── App.test.js
│ │ └── index.js
├── constants.js
├── index.css
├── index.js
├── pages
│ └── Lobby
│ │ └── NewGame
│ │ ├── NewGame.js
│ │ ├── NewGame.test.js
│ │ └── index.js
├── setupTests.js
├── store
│ ├── gameSlice.js
│ ├── gameSlice.test.js
│ └── index.js
├── theme.js
└── util
│ └── random.js
├── test
├── helloWorld.test.js
└── insertGame.test.js
└── tutorial
├── architecture-astra.png
├── architecture-stargate.png
├── architecture.png
├── architecture1.png
├── architecture2.png
├── are-you-ready.gif
├── astra-choose-a-plan-annotated.png
├── astra-choose-a-plan-serverless-annotated.png
├── astra-create-and-configure-annotated.png
├── astra-create-and-configure-serverless-annotated.png
├── astra-dashboard-active.png
├── astra-dashboard-pending.png
├── astra-dashboard-serverless-active.png
├── astra-database-click-connect.png
├── astra-document-api-variables.png
├── astra.png
├── battlestax.png
├── component-state-change.png
├── createAndInitGame.png
├── createGame.png
├── crew
├── cedrick.png
├── chris.png
├── david.png
├── kirsten.png
└── rebecca.png
├── dataflow.png
├── discord.png
├── document-api.png
├── empty-game-function.png
├── enroll.png
├── gameSlice.png
├── gameSliceFull.png
├── gameslice-ide.png
├── gamestate.png
├── github-fork-repo-complete.png
├── github-fork-repo-whereto.png
├── github-fork-repo.png
├── github-workflows-package-json.png
├── github-workflows-yml.png
├── gitpod-button-click.png
├── gitpod-edit-insertGame-test-1.png
├── gitpod-edit-insertGame-test-2.png
├── gitpod-edit-insertGame-test-faker.png
├── gitpod-edit-insertGame-test-result.png
├── gitpod-edit-insertGame-test.png
├── gitpod-env.png
├── gitpod-full-url.png
├── gitpod-hello-world.png
├── gitpod-helloworld-test-js.png
├── gitpod-launch.png
├── gitpod-nav-to-your-repo.png
├── gitpod-new-terminal-helloWorld-endpoint.png
├── gitpod-new-terminal.png
├── gitpod-paste-in-gitpod-url.png
├── gitpod-paste-to-env-end-result.png
├── gitpod-paste-to-env-with-games.png
├── gitpod-paste-to-env.png
├── gitpod-start.png
├── gitpod-test.png
├── gitpod-uh-oh.png
├── gitpod-welcome.png
├── hook.png
├── hooks.png
├── icon-chat.png
├── icon-materials.png
├── icon-questions.png
├── icon-questions2.png
├── icon-recording.png
├── insert.png
├── jamstack
├── CDN.png
├── dx.gif
├── jam-1.png
├── jam-2.png
├── jam-3.png
├── jam-4.png
├── jam-5.png
├── logo-angular.png
├── logo-gatsby.png
├── logo-graphql.png
├── logo-html.png
├── logo-hugo.png
├── logo-jekyll.png
├── logo-markdown.png
├── logo-next.png
├── logo-react.png
├── logo-rest.png
├── logo-vuejs.png
├── maintenance.gif
├── slow.jpeg
├── ssg-flow.png
├── what-is-cdn-1.png
├── what-is-cdn-2.png
└── your-problem.png
├── line.png
├── local-test.png
├── login-1000.png
├── mentimeter.png
├── mentimeter2.png
├── mentimeter3.png
├── mentimeter4.png
├── netlify-createsite-1.png
├── netlify-createsite-10.png
├── netlify-createsite-2.png
├── netlify-createsite-3.png
├── netlify-createsite-4.png
├── netlify-createsite-5.png
├── netlify-createsite-6.png
├── netlify-createsite-7.png
├── netlify-createsite-8-2.png
├── netlify-createsite-8.png
├── netlify-createsite-9.png
├── netlify-empty.png
├── netlify-final-deploy.png
├── netlify-function-handler.png
├── netlify-functions-cloud.png
├── netlify-functions-helloWorld-endpoint.png
├── netlify-functions-helloWorld-output.png
├── netlify-functions-helloWorld.png
├── netlify-helloWorld-output.png
├── netlify-pageview1.png
├── netlify-pageview2.png
├── netlify-signin.png
├── netlify-toml-config.png
├── netlify-vars-build-edit-save.png
├── netlify-vars-build-edit.png
├── netlify-vars-new-variable.png
├── netlify-vars-site-settings.png
├── netlify-vars-verify.png
├── netlify.png
├── new-game-test.png
├── newgame-ide.png
├── react-flow.png
├── react-hooks.png
├── react-redux-flow.png
├── redux-lifecycle.png
├── redux-reducers.png
├── rocket-animation.gif
├── setup-github-1.png
├── setup-github-10.png
├── setup-github-11.png
├── setup-github-2.png
├── setup-github-3.png
├── setup-github-4.png
├── setup-github-5.png
├── setup-github-6.png
├── setup-github-7.png
├── setup-github-8.png
├── setup-github-9.png
├── setup-github-verify-secrets.png
├── share-facebook.png
├── share-linkedin.png
├── share-on-twitter.png
├── share-twitter.png
├── signin-raw.png
├── slice-test.png
├── ssg-flow.png
├── stargate.png
├── start-localhost.png
├── state-flow.png
├── step-1-code-solution.png
├── step-1-test-functions.png
├── step-3-code-solution.png
├── step-4-code-solution.png
├── template-click-use-template.png
├── template-complete.png
├── template-create-repo.png
├── template-ctrl-click.png
├── template-nav-back-to-step0.png
├── template-nav-to-create-astra.png
├── testing.png
├── thankyou.gif
├── thumbup.png
├── tools.png
├── ui-game-code.png
├── view.png
├── vscode.png
├── well-done.png
└── workshop-live.png
/.env.example:
--------------------------------------------------------------------------------
1 | ASTRA_DB_APPLICATION_TOKEN=
2 | ASTRA_DB_KEYSPACE=
3 | ASTRA_DB_ID=
4 | ASTRA_DB_REGION=
5 | GAMES_COLLECTION=games
6 |
--------------------------------------------------------------------------------
/.github/workflows/tests.yml:
--------------------------------------------------------------------------------
1 | name: BattleStax Tests
2 | on:
3 | pull_request:
4 | branches:
5 | - master
6 | jobs:
7 | battlestax-tests:
8 | env:
9 | ASTRA_DB_USERNAME: ${{ secrets.ASTRA_DB_USERNAME }}
10 | ASTRA_DB_PASSWORD: ${{ secrets.ASTRA_DB_PASSWORD }}
11 | ASTRA_DB_KEYSPACE: ${{ secrets.ASTRA_DB_KEYSPACE }}
12 | ASTRA_DB_ID: ${{ secrets.ASTRA_DB_ID }}
13 | ASTRA_DB_REGION: ${{ secrets.ASTRA_DB_REGION }}
14 | GAMES_COLLECTION: ${{ secrets.GAMES_COLLECTION }}
15 | runs-on: ubuntu-latest
16 | strategy:
17 | matrix:
18 | node-version: [12.x]
19 | steps:
20 | - uses: actions/checkout@v2
21 | - name: Use Node.js ${{ matrix.node-version }}
22 | uses: actions/setup-node@v1
23 | with:
24 | node-version: ${{ matrix.node-version }}
25 | - name: npm install and build
26 | run: |
27 | npm install
28 | npm run build
29 | - name: client tests
30 | run: npm run test
31 | - name: function tests
32 | run: npm run test:functions
33 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | venv
4 | .env
5 |
6 | # dependencies
7 | /node_modules
8 | /.pnp
9 | .pnp.js
10 |
11 | # testing
12 | /coverage
13 |
14 | # production
15 | /build
16 |
17 | # misc
18 | .DS_Store
19 | .env.local
20 | .env.development.local
21 | .env.test.local
22 | .env.production.local
23 |
24 | package-lock.json
25 | npm-debug.log*
26 | yarn-debug.log*
27 | yarn-error.log*
28 |
--------------------------------------------------------------------------------
/.gitpod.yml:
--------------------------------------------------------------------------------
1 | image: gitpod/workspace-full
2 | tasks:
3 | - init: yarn install; pip3 install httpie-astra
4 | command: echo "Please Define .env file if not exist"
5 | ports:
6 | - port: 3000
7 | onOpen: open-browser
8 | github:
9 | prebuilds:
10 | master: true
11 | branches: false
12 | pullRequests: false
13 | pullRequestsFromForks: false
14 | addCheck: false
15 | addComment: false
16 | addBadge: false
17 | addLabel: false
18 |
--------------------------------------------------------------------------------
/BATTLESTAX.md:
--------------------------------------------------------------------------------
1 | # BattleStax
2 |
3 | BattleStax is a stateful JAMStack game that is wholesome fun for the entire crew.
4 |
5 | [](https://github.com/DataStax-Academy/battlestax/actions)
6 |
7 | [](https://app.netlify.com/sites/battlestax-tutorial/deploys)
8 |
9 | [](https://gitpod.io/#https://github.com/DataStax-Academy/battlestax)
10 |
11 | ## Project Structure
12 |
13 | BattleStax's folder structure is (mostly) generated from [Create React App](https://github.com/facebook/create-react-app). We then add a Netlify Functions and Github Actions.
14 |
15 | - .github - [Github Actions](https://github.com/features/actions) configuration
16 | - .storybook - [Storybook Documentation](https://storybook.js.org/) Storybook configuration
17 | - functions - [Netlify Functions](https://www.netlify.com/products/functions/) Lambda function definition
18 | - public - Static files
19 | - src - [create-react-app](https://github.com/facebook/create-react-app) source files
20 | - tutorial - tutorial content
21 |
22 | ### Prerequisites
23 | - A Github account - [Github](https://github.com)
24 | - A fork of the `BattleStax Tutorial` repository - [Repository](https://github.com/kidrecursive/battlestax-tutorial)
25 | - NodeJS 12 - [Download](https://nodejs.org/en/download/) - Recommended alternative: Setup your local development environment with [nodeenv](#nodeenv)
26 | - A Netlify account (it's free!) - [Netlify](https://www.netlify.com)
27 | - An Astra account and database (it's free!) - [Astra](https://astra.datastax.com/)
28 |
29 | ### Using `nodeenv` (recommended)
30 |
31 | Using [nodeenv](https://github.com/ekalinin/nodeenv) allows you to keep your NodeJS version and dependencies isolated for the project you're
32 | working on. To get started using it for BattleStax, install it using [homebrew](https://formulae.brew.sh/formula/nodeenv) or `easy_install`.
33 | ```sh
34 | # install using homebrew
35 | brew install nodeenv
36 |
37 | # install using easy_install
38 | sudo easy_install nodeenv
39 | ```
40 |
41 | Once nodeenv is installed, setup a virtualenv in the project folder, and then activate it.
42 |
43 | ```sh
44 | # setup a nodeenv in the venv folder using NodeJS 12
45 | nodeenv venv --node=12.18.4
46 |
47 | # activate the nodeenv
48 | . venv/bin/activate
49 | ```
50 |
51 | ### Working with BattleStax
52 |
53 | Create a `.env` file and fill it with values from the `.env.example` file.
54 |
55 | Make sure the package dependencies are installed
56 | ```sh
57 | # install dependencies
58 | npm install
59 | ```
60 |
61 | Then, start the app in dev mode. Changes in the `src` or `functions` directories will trigger reloads.
62 |
63 | ```sh
64 | # start battlestax in dev mode
65 | npm run dev
66 | ```
67 |
68 | ### UI Storybook
69 |
70 | To run storybook, make sure you have some {ComponentName}.stories.js files and then:
71 |
72 | ```sh
73 | # start storybook
74 | npm run storybook
75 | ```
76 |
77 | ### Client Testing
78 |
79 | Test your react/redux client
80 | ```sh
81 | # run the client tests
82 | npm test
83 | ```
84 |
85 | ### Netlify Function Testing
86 |
87 | Test your netlify functions
88 |
89 | ```sh
90 | # run the function tests
91 | npm run test:functions
92 | ```
93 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, sex characteristics, gender identity and expression,
9 | level of experience, education, socio-economic status, nationality, personal
10 | appearance, race, religion, or sexual identity and orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | ## Enforcement
56 |
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at . All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 |
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 |
68 | ## Attribution
69 |
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 |
73 | [homepage]: https://www.contributor-covenant.org
74 |
75 | For answers to common questions about this code of conduct, see
76 | https://www.contributor-covenant.org/faq
77 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | When contributing to this repository, please first discuss the change you wish to make via issue,
4 | email, or any other method with the owners of this repository before making a change.
5 |
6 | Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
7 |
8 | ## Found an Issue?
9 | If you find a bug in the source code or a mistake in the documentation, you can help us by
10 | [submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can
11 | [submit a Pull Request](#submit-pr) with a fix.
12 |
13 | ## Want a Feature?
14 | You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub
15 | Repository. If you would like to *implement* a new feature, please submit an issue with
16 | a proposal for your work first, to be sure that we can use it.
17 |
18 | * **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
19 |
20 | ## Contribution Guidelines
21 |
22 | ### Submitting an Issue
23 | Before you submit an issue, search the archive, maybe your question was already answered.
24 |
25 | If your issue appears to be a bug, and hasn't been reported, open a new issue.
26 | Help us to maximize the effort we can spend fixing issues and adding new
27 | features, by not reporting duplicate issues. Providing the following information will increase the
28 | chances of your issue being dealt with quickly:
29 |
30 | * **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
31 | * **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
32 | * **Reproduce the Error** - provide a live example or a unambiguous set of steps
33 | * **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
34 | causing the problem (line of code or commit)
35 |
36 | ### Submitting a Pull Request (PR)
37 | Before you submit your Pull Request (PR) consider the following guidelines:
38 |
39 | * Search the repository (https://github.com/bechbd/[repository-name]/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort.
40 |
41 | * Create a fork of the repo
42 | * Navigate to the repo you want to fork
43 | * In the top right corner of the page click **Fork**:
44 | 
45 |
46 | * Make your changes in the forked repo
47 | * Commit your changes using a descriptive commit message
48 | * In GitHub, create a pull request: https://help.github.com/en/articles/creating-a-pull-request-from-a-fork
49 | * If we suggest changes then:
50 | * Make the required updates.
51 | * Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
52 |
53 | ```shell
54 | git rebase master -i
55 | git push -f
56 | ```
57 |
58 | That's it! Thank you for your contribution!
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | # BattleStax
3 | *50 minutes, Advanced, [Start Building](https://github.com/DataStax-Examples/battlestax#prerequisites)*
4 |
5 | [](https://gitpod.io/from-referrer/)
6 |
7 | BattleStax is a stateful JAMStack game that is wholesome fun for the entire crew.
8 |
9 |
10 | 
11 |
12 |
13 | ## Objectives
14 | * Deploy a scalable JAMStack app to production
15 | * Leverage a good CI/CD process to manage your JAMStack App
16 |
17 | ## How this works
18 | The BattleStax players watch a lobby screen while playing the game on their devices.
19 |
20 |
21 | 
22 |
23 |
24 | [JAMstack](https://jamstack.org/) is a big leap forward in how we can write web applications that are easy to write, deploy, scale, and also maintain. Using this approach means that newly created content is rendered from a content API, while a static render of it is being built into the site for future.
25 |
26 | ## Get Started
27 | To build and play with this app, follow the build instructions that are located here: [https://github.com/DataStax-Examples/battlestax](https://github.com/DataStax-Examples/battlestax#prerequisites)
28 |
29 |
30 | # Running BattleStax
31 | Follow the instructions below to get started.
32 |
33 | ## Prerequisites
34 | Let's do some initial setup by creating a serverless(!) database.
35 |
36 | ### DataStax Astra
37 | 1. Create a [DataStax Astra account](https://dtsx.io/3jGT8b4) if you don't already have one:
38 | 
39 |
40 | 2. On the home page. Locate the button **`Create Database`**
41 | 
42 |
43 | 3. Locate the **`Get Started`** button to continue
44 | 
45 |
46 | 4. Define a **database name**, **keyspace name** and select a database **region**, then click **create database**.
47 | 
48 |
49 | 5. Your Astra DB will be ready when the status will change from *`Pending`* to **`Active`** 💥💥💥
50 | 
51 |
52 | 6. After your database is provisioned, we need to generate an Application Token for our App. Go to the `Settings` tab in the database home screen.
53 | 
54 |
55 | 6. Select `Admin User` for the role for this Sample App and then generate the token. Download the CSV so that we can use the credentials we need later.
56 | 
57 |
58 | 7. After you have your Application Token, head to the database connect screen and copy the connection information that we'll need later. We'll replace `ASTRA_DB_APPLICATION_TOKEN` with the `Token` value that is part of your Application Token.
59 | 
60 |
61 | ### Github
62 | 1. Click `Use this template` at the top of the [GitHub Repository](https://github.com/DataStax-Examples/battlestax):
63 | 
64 |
65 | 2. Enter a repository name and click 'Create repository from template':
66 | 
67 |
68 | 3. Clone the repository:
69 | 
70 |
71 |
72 | ## Running the full game
73 | *Make sure you've completed the [prerequisites](https://github.com/DataStax-Examples/battlestax#prerequisites) before starting this step*
74 | - [Running on your local machine](https://github.com/DataStax-Examples/battlestax#running-on-your-local-machine)
75 |
76 | ### Running on your local machine
77 |
78 | 1. Check out the `full-game` branch
79 | ```sh
80 | git fetch
81 | git checkout full-game
82 | ```
83 |
84 | 2. Create a `.env` file and fill it with values from the `.env.example` file.
85 |
86 | 3. Make sure the package dependencies are installed
87 | ```sh
88 | # install dependencies
89 | npm install
90 | ```
91 |
92 | 3. Then, start the app in dev mode. Changes in the `src` or `functions` directories will trigger reloads.
93 | ```sh
94 | # start battlestax in dev mode
95 | npm run dev
96 | ```
97 |
98 | ## Tutorial Steps
99 | The above instructions are great to get you up and running pretty quickly, but if you would like to learn how to fully deploy the application to production with JAMStack then click the button below to get started.
100 |
101 |