Skip to content

Commit

Permalink
Merge pull request #6 from WHS-Dev-Team/v.1
Browse files Browse the repository at this point in the history
remove useless
  • Loading branch information
H4CK3RG0D authored Feb 23, 2024
2 parents 6cc8722 + 7f634d4 commit 9418528
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 45 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# Senior-Assassination-WHS

Senior Assassination is a game where you are a student at Wheeling High School and you are trying to kill your classmates. You can do this by using a variety of weapons and items. You can also use your classmates to kill other classmates. The goal of the game is to be the last student standing.
Senior Assassination is a game where you are a student at a High School and you are trying to kill your classmates. You can do this by using a variety of weapons and items. You can also use your classmates to kill other classmates. The goal of the game is to be the last student standing. And of course, there is a prize pool.

# Installation
To install the game, you will need to download the game files from the GitHub repository. You will need the following requirements to run the game:
```
- Node.js (LTS)
- npm (Node Package Manager)
- MongoDB and MongoDB Compass
```

# Database Setup
You will need to also set up a MongoDB database to store the game data. You can do this by creating a new database in MongoDB Compass and then setting up the database connection in the `mongoconnect.cjs` file. You will need to replace the `uri` variable with your own MongoDB connection string.


# Running the Game Locally
To run this game locally, you will need to run the following commands in the terminal:
```
npm run first-time
```
This will install all the necessary packages and dependencies for the game to run. Then to start the game, run the following command:
```
npm run start
```

# Running the Game Online
To run this game online, you will need a web server to host the game. You can use a service like Heroku to host the game. Once you have a web server set up, you need to connect it to a working domain to host the game. Occe you have the domain, you can run the auto deploy script to deploy the game to the web server.
16 changes: 8 additions & 8 deletions project-hierarchy.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Senior-Assassination-WHS
Senior-Assassination
├─ backend
│ ├─ handler
│ └─ handler.cjs
Expand All @@ -8,12 +8,9 @@ Senior-Assassination-WHS
│ ├─ routes
│ │ └─ api.js
│ └─ server.cjs
├─ dist
│ ├─ bundle.js
│ ├─bundle.js.LICENSE.txt
│ ├─1f5bf2667689edcbdbf73ea7c5dbcdfd.node
│ └─20ebddf591928620189b2d61e6a7ebb5.node
├─ frontend
| ├─ data
│ │ └─ localData.json
│ ├─ about.html
│ ├─ index.html
│ ├─ leaderboard.html
Expand All @@ -37,5 +34,8 @@ Senior-Assassination-WHS
├─ people.json // for testing - not used anymore
├─ Procfile
├─ README.md
├─ run.js
└─ webpack.config.cjs
└─ run.js




36 changes: 0 additions & 36 deletions webpack.config.cjs

This file was deleted.

0 comments on commit 9418528

Please sign in to comment.