Giter VIP home page Giter VIP logo

gamehouse's Introduction


Logo

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributors

About The Project ๐ŸŽฎ๐ŸŒŽ

Have you ever had a virtual event where you donโ€™t know if the attendees are engaged? Maybe theyโ€™re quiet or shy? Or, are you trying to host a virtual gathering but want to add some spice to your event to engage the audience? Well, we got the solution for you! ๐Ÿ‘

GameHouse is a web app that connects people based on their interests in a 3d game environment. Our project includes rooms for people to come together and communicate with each other via chat or voice while also interacting with each other virtually! Check out our web app and enjoy your hangout!

Technical Backbone ๐Ÿ’ป๐Ÿ’ซ

Some of the completed user stories are:

  • Allow multiple users to join the same room.
  • Allow users to communicate through an online chat feature.
  • Allow users to communicate through voice chat.

Screenshots of the web app

Deployed at: WIP

Built With ๐Ÿ’ปโ˜€๏ธ

Getting Started

This section will work you through how you can get started with the project.

Installation

  1. You will need NodeJS, Yarn, Web3.js and Truffle.js for this project.
  2. Clone the repo
    git clone https://github.com/APiligrim/Tetra.git
  3. CD into the project directory
    cd Tetra
  4. CD into web folder
    cd web
  5. Install yarn packages
    yarn install
  6. Start the Server
    yarn start
  7. For the backend server
    cd ../server
  8. Install yarn packages
    yarn install
  9. Start the Server
    yarn start

License

Distributed under the MIT License. See LICENSE for more information.

Contributors

  1. Josh Improgo - github
  2. Jonas Improgo - github
  3. Anastasiya Uraleva - github
  4. Kristy - github

Screenshots

Project Starter

A starter repo for building CUNY Tech Prep projects with React, Express.js, and Sequelize.js

Test Test 2

Stack

API

  • express.js
  • sequelize.js

React client

  • Built using create-react-app and configured to work with the api.
  • Bootstrap 4.x added to /client/public/index.html
  • React Router

Project Structure

.
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ api
โ”‚ย ย  โ”œโ”€โ”€ app.js
โ”‚ย ย  โ”œโ”€โ”€ config
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ config.json
โ”‚ย ย  โ”œโ”€โ”€ controllers
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ appConfig.js
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ index.js
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ posts.js
โ”‚ย ย  โ””โ”€โ”€ models
โ”‚ย ย      โ”œโ”€โ”€ index.js
โ”‚ย ย      โ””โ”€โ”€ post.js
โ”œโ”€โ”€ client
โ”‚ย ย  โ”œโ”€โ”€ README.md
โ”‚ย ย  โ”œโ”€โ”€ package-lock.json
โ”‚ย ย  โ”œโ”€โ”€ package.json
โ”‚ย ย  โ”œโ”€โ”€ public
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ favicon.ico
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ index.html
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ logo192.png
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ logo512.png
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ manifest.json
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ robots.txt
โ”‚ย ย  โ””โ”€โ”€ src
โ”‚ย ย      โ”œโ”€โ”€ App.css
โ”‚ย ย      โ”œโ”€โ”€ App.js
โ”‚ย ย      โ”œโ”€โ”€ App.test.js
โ”‚ย ย      โ”œโ”€โ”€ components
โ”‚ย ย      โ”‚ย ย  โ”œโ”€โ”€ Loading.js
โ”‚ย ย      โ”‚ย ย  โ””โ”€โ”€ Post.js
โ”‚ย ย      โ”œโ”€โ”€ index.css
โ”‚ย ย      โ”œโ”€โ”€ index.js
โ”‚ย ย      โ”œโ”€โ”€ logo.svg
โ”‚ย ย      โ”œโ”€โ”€ pages
โ”‚ย ย      โ”‚ย ย  โ”œโ”€โ”€ AboutUsPage.js
โ”‚ย ย      โ”‚ย ย  โ”œโ”€โ”€ PostFormPage.js
โ”‚ย ย      โ”‚ย ย  โ”œโ”€โ”€ PostsListPage.js
โ”‚ย ย      โ”‚ย ย  โ””โ”€โ”€ ShowPostPage.js
โ”‚ย ย      โ””โ”€โ”€ serviceWorker.js
โ”œโ”€โ”€ package-lock.json
โ””โ”€โ”€ package.json

Dev Setup

Each team member will need to do this on their local machine.

Create a postgres db

Create a user in postgres named ctp_user with the password ctp_pass:

This only needs to be done one time on your machine You can create additional users if you want to.

createuser -P -s -e ctp_user

Create a separate db for this project:

createdb -h localhost -U ctp_user app2019_development

You will create a DB for each project you start based on this repo. For other projects change app2019_development to the new apps database name.

For more details see this installing postgres guide

Running the app

For local development you will need two terminals open, one for the api-backend and another for the react-client.

Clone this app, then:

# api-backend terminal 1
cp .env.example .env
npm install
npm run dev
# react-client terminal 2
cd client
npm install
npm start

In production you will only deploy a single app. The react client will build into static files that will be served from the backend.

Deployment

Setting up Heroku

Install the heroku cli if you don't already have it.

You will also need a heroku account And this will only be done once on your machine

# on mac
brew install heroku/brew/heroku
heroku login

Create a Heroku project

Next, cd into this project directory and create a project:

heroku create cool-appname
heroku addons:create heroku-postgresql:hobby-dev

This will deploy your apps to https://cool-appname.herokuapp.com, assuming that it is not taken already.

You only need to do this once per app

Deploying the app

Whenever you want to update the app run this command.

git push heroku main

This command deploys your main branch. You can change that and deploy a different branch such as: git push heroku development

gamehouse's People

Contributors

josh-improgo avatar apiligrim avatar jonas-i avatar

Stargazers

Kristy avatar  avatar

gamehouse's Issues

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.