diff --git a/README.md b/README.md index f53cd9dd..a8fc6865 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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. diff --git a/project-hierarchy.txt b/project-hierarchy.txt index a33d2513..a18a0f94 100644 --- a/project-hierarchy.txt +++ b/project-hierarchy.txt @@ -1,4 +1,4 @@ -Senior-Assassination-WHS +Senior-Assassination ├─ backend │ ├─ handler │ └─ handler.cjs @@ -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 @@ -37,5 +34,8 @@ Senior-Assassination-WHS ├─ people.json // for testing - not used anymore ├─ Procfile ├─ README.md -├─ run.js -└─ webpack.config.cjs \ No newline at end of file +└─ run.js + + + + diff --git a/webpack.config.cjs b/webpack.config.cjs deleted file mode 100644 index 96fd6e20..00000000 --- a/webpack.config.cjs +++ /dev/null @@ -1,36 +0,0 @@ -// webpack.config.cjs -const path = require('path'); - -module.exports = { - entry: './frontend/scripts/personInteractions.js', - output: { - filename: 'bundle.js', - path: path.resolve(__dirname, 'dist'), - }, - resolve: { - fallback: { - "stream": require.resolve("stream-browserify"), - "url": require.resolve("url/"), - "fs": false, - "timers": require.resolve("timers-browserify"), - "dns": false, - "crypto": require.resolve("crypto-browserify"), - "http": require.resolve("stream-http"), - "net": false, - "tls": false, - "os": require.resolve("os-browserify/browser"), - "zlib": require.resolve("browserify-zlib"), - "assert": require.resolve("assert/"), - "querystring": require.resolve("querystring-es3"), - "express": require.resolve("express"), - } - }, - module: { - rules: [ - { - test: /\.node$/, - loader: 'node-loader', - }, - ], - }, -};