Bug Busters

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Our goal is to create a game hub in which everyone and anyone can come together and socialize with games. We look to add more games in the future where we can incorporate games that require to be there physically but bring them to life virtually through the browser!

(back to top)

Built With

• React.js
• Create-React-App
• PHP

(back to top)

Getting Started

The program needs node packages as its library.

Prerequisites

You need to install npm on your system.

Node Package Manager: npm

• brew npm package

  brew install node

Installation

1. Clone the repo

   git clone (https://github.com/xlab-classes/cse442-spring2022-team-bug-busters)

2. Install NPM packages

   npm install

To Run Locally

Frontend

• Start the frontend app

1. To install app dependenices

   npm install

2. To start application

   npm start

Backend

• Since the backend is already deployed for you we do not need to worry about it.

To Deploy onto Apache Servers

1. To install app dependenices

   npm install

2. To create a production build

   npm run build

3. Copy the backend folder into the build folder
4. Then use

   scp -r [path/to/source/file] [username@targetHost:target/path]

   to secure copy onto the existing Apache server under University at Buffalo. Once this is done the Apache server automatically deploys onto the website Bug Busters

(back to top)

Usage

Placeholder.

For more examples, please refer to the Documentation

(back to top)

Roadmap

Frontend

• Login Page
• Register Page
• Dashboard
  • Leaderboard
  • List of games
• Settings Page
  • Account Settings
  • UI Settings

Backend

• RESTful API

Database

• MySQL Database
  • User Account
  • Scores

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the APACHE License, version 2.0. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/xlab-classes/cse442-spring2022-team-bug-busters

(back to top)