Welcome to CASTAWAY: Flight of the Pheonix. This text-based game is a science-fiction survival game based on the classic Choose Your Own Adventure stories. Stranded with your wrecked spaceship, you will have to rely on your wits and decision making to chart a course towards survival in CASTAWAY: Flight of the Pheonix!
Here are some instructions on installation.
To start using this application right away, simply navigate to the following link:
To run this on your local PC, utlizing a local MySQL database, follow these steps:
- Clone the repository onto your local PC.
- Create a new schema in your MySQL database called "cyoa_db".
- Open an integrated terminal where the data was cloned to and run "npm i".
- Utlize the Sequelize-CLI-ReadMe file to migrate and seed your database.
- Initiate the server.js file in your terminal
- Load the application your browser.
Express is a node.js library that creates a server. It utilizes routes which are accessed via the browser for this applicaiton. There are API and HTML routes:
- API Routes: These routes deliver JSON formatted information from the database and are used in js related actions.
- HTML routes: These routes deliver an actual HTML page to the user by way of express-handlebars
Sequelize is a database management library. This application makes use of sequelize and the sequelize-cli (command line interface) to create and provide access to the Castaway database. Using the Sequelize-cli-readme.md file found in this repository, the user can setup their own command line interface to quickly create, migrate, and seed their local database.
Handlebars are a tool that allows the delivery of dynamic pages to the user as well as allowing re-use of HTML 'templates'. It is possible to send user-specified information to the page, or information that is regularly updated, or conditional page elements, and even more.
Public assets are defined in the express server script. These are how the HTML handlebars access front-end JS, style-sheets, and more.
If you'd like to make a contribution to CASTAWAY: Flight of the Phoenix (with content, new mechanics or art etc.) make a pull request with a detailed commit description of your contribution.
For questions regarding this repo contact me at charlie.bateman117@gmail.com or visit my repository at https://github.com/Team-CYOA/CYOA
Charles Latrobe-Bateman: Github, E-Mail.
Erik Portillo: Github, E-Mail.
Shawn Flanigan: Github, E-Mail.
Jef Drawbaugh @ Cascadnac Sound for the amazing original music.
Copyright 2021 undefined
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.