Git Product home page Git Product logo

yoere's Introduction

Yoere

Overview

A text-based escape room game

Team Members

  • Zach Schwartz (Art)
  • Thomas Capen (Story)
  • Andrew Hoener (Code)

Application Initialization

To use this application you should have node, npm and mongodb installed and issue the following commands:

  1. npm install: this will install the required node libraries.
  2. npm run buildDev: this will compile the application code and produce a dist directory. Compresses JS files into main.js and links to html files. Initializes your mongodb with the necessary data for the application to function.
  3. npm start: this will run the Express server, server.js, allowing you to view the running application in the browser window.

Directory & File Structure

  • src/css: Custom css files
  • src/html: Base HTML files, mostly blank except for React Hooks
  • src/img: Images for the build, copied into dist/img
  • src/js: React components and javascript
  • src/server: server-dev, the main server file
  • index.js: Imports from all the react components
  • Webpack configs: Bundles all the stuff together

#Notes This app uses lots of large images, so the initial load may be slow.
Additional performance should come from minifying/uglifying all of the code but at this point I haven't bothered to make a webpack config for production, since it wasn't used at all during development, and once the initial load is done, performance is just fine

yoere's People

Contributors

drewhoener avatar sspriggs avatar tcapen avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.