Housing keeping

Author: TheNirmata

.env

@@ -16,7 +16,7 @@ We use github to host code, to track issues and feature requests, as well as acc
 
 Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
 
-1. Fork the repo and create your branch from `main`.
+1. Fork the repo and create your branch from `dev`.
 2. If you've added code that should be tested, add tests.
 3. Ensure the test suite passes.
 4. Make sure your code lints.

CONTRIBUTING.md

@@ -86,8 +86,6 @@
 </br>
 </br>
 <br/>
-<br/>
-<br/>
 
 # Accessing Grafana
 
@@ -156,8 +154,6 @@
 
 </br>
 <br/>
-<br/>
-<br/>
 
 # Accessing Prometheus <br/></br>
 
@@ -193,7 +189,37 @@
 
 </br>
 <br/>
-<br/>
+
+
+# Running Zeus
+
+1. Fork and clone the `dev` branch onto your local branch.
+   ``` bash
+   https://github.com/oslabs-beta/Zeus.git
+   ```
+
+2. Install all the dependencies
+   ``` bash 
+      npm install 
+   ```
+3. Create ```process.env``` file at the root directory
+   ``` bash
+   root
+      ├─ process.env
+      ├─ electron
+      └─ src
+   ``` 
+4. Connect to NoSQL database in .env
+
+   ``` js
+   mongoURI = "Your NoSQL URI string"
+   ```
+5. Ensure your cluster is running and then you can start the application with:
+   ``` bash
+   npm run electron
+   ```
+
+</br>
 <br/>
 
 # Made with
@@ -226,9 +252,9 @@
 ![Prometheus](https://img.shields.io/badge/Prometheus-E6522C?style=for-the-badge&logo=Prometheus&logoColor=white)
 
 </br>
+
 <br/>
-<br/>
-<br/>
+
 
 # Contributions
 
@@ -249,10 +275,10 @@ guidelines from this repo.
    ``` bash 
       npm install 
    ```
-4. Create ```.env``` file at the root directory
+4. Create ```process.env``` file at the root directory
    ``` bash
    root
-      ├─ .env
+      ├─ process.env
       ├─ electron
       └─ src
    ``` 
@@ -269,13 +295,10 @@ guidelines from this repo.
 
 </br>
 <br/>
-<br/>
-<br/>
 
 # Founders
 
-- Ed Cho [LinkedIn](https://www.linkedin.com/in/edcho720/)| [GitHub](https://github.com/edcho720)
+- Ed Cho [LinkedIn](https://www.linkedin.com/in/edcho720/) | [GitHub](https://github.com/edcho720)
 - John Wroge [LinkedIn](https://www.linkedin.com/in/john-wroge/) | [GitHub](https://github.com/johnwroge)
 - Harvey Li [LinkedIn](https://www.linkedin.com/in/harvey-li/) | [GitHub](https://github.com/harvli)
-- Amy (Aimée) Nguyen [LinkedIn](https://www.linkedin.com/in/aqn/) |
-  [GitHub](https://github.com/DoctorCodeine)
+- Amy (Aimée) Nguyen [LinkedIn](https://www.linkedin.com/in/aqn/) | [GitHub](https://github.com/DoctorCodeine)

README.md

@@ -21,7 +21,7 @@ mongoose
 	.connect(URI, {
 		useNewUrlParser: true,
 		useUnifiedTopology: true,
-		dbName: 'zeus',
+		// dbName: 'zeus',
 	})
 	.then(() => console.log('🦆🦆🦆🦆🦆🦆🦆🦆  Mongoose is connected'))
 	.catch((err: ErrorRequestHandler) => {
@@ -38,5 +38,3 @@ const userSchema = new mongoose.Schema({
 const Users = mongoose.model('Users', userSchema);
 // Export db
 module.exports = Users;
-
-export {};

src/server/database/db.ts

@@ -23,12 +23,5 @@
       ],
 	},
 	"include": ["src/**/*", "__test__/"],
-
-	// 	"paths": {
-	// 		"*": [
-	// 				"node_modules/*"
-	// 		]
-	// },
-	// "exclude": ["node_modules"],
 }
 //"ESNext" in module