Isaac/merge main release

.eslintrc.js

@@ -9,6 +9,8 @@ module.exports = {
     '@typescript-eslint/explicit-module-boundary-types': 0,
     '@typescript-eslint/no-unused-vars': 0,
     'semi-style': ['error', 'last'],
+    'import/named': 0,
+    'import/prefer-default-export': 0,
   },
   // This gets rid of weird react error for non-react project
   settings: {

.github/hooks/pre-commit

@@ -0,0 +1 @@
+npm run jest

.gitignore

@@ -8,6 +8,7 @@ nohup.out
 */certificates/*
 Makefile
 start.sh
+*secrets*
 
 # ignore database dumps
-dump/
+dump/

README.md

@@ -1,22 +1,27 @@
-# volume-backend  
+# volume-backend
 
 An open-sourced backend for Volume, a news aggregator for Cornell's publications
-and magazines. Made by [Cornell AppDev](cornellappdev.com). 
+and magazines. Made by [Cornell AppDev](cornellappdev.com).
 
 Tech stack:
+
 1. Typescript/Node.js
 2. MongoDB
 3. GraphQL
 
-## Installation  
+## Installation
 
-To run this project, you must have [Node.js](https://nodejs.org/en/download/) and [Typescript](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html) installed on your machine. 
+To run this project, you must have [Node.js](https://nodejs.org/en/download/) and [Typescript](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html) installed on your machine.
 
 Clone the project with
 
 `git clone https://github.com/cuappdev/volume-backend.git`
 
-After cloning the project `cd` into the new directory and install dependencies with 
+After cloning the project `cd` into the new directory run
+
+`git config core.hooksPath .github/hooks`
+
+and install dependencies with
 
 `npm install`
 
@@ -28,9 +33,13 @@ To run the project, use
 
 Make sure `MongoDB` is installed. [See installation guide](https://docs.mongodb.com/manual/installation/).
 
-To view your database, enter your terminal and run 
+To run MongoDB on a MacOS device, run
+
+`brew services start mongodb-community@6.0` (6.0 may be outdated, check website for updated version).
+
+and connect MongoSH to a running instance using
 
-`mongo`
+`mongosh`
 
 From here, you can interact with your database by typing `use <db_name>`.
 
@@ -44,4 +53,4 @@ We recommend using [`direnv`](https://direnv.net/). To set up, run the following
 
 ## Configuration(optional)
 
-We recommend using ESLint and Prettier for linting/formatting. If you are using VSCode, they can be downloaded directly through the Extensions panel. Run ESLint on the codebase with `npm run lint` and Prettier with  `npm run format`.
+We recommend using ESLint and Prettier for linting/formatting. If you are using VSCode, they can be downloaded directly through the Extensions panel. Run ESLint on the codebase with `npm run lint` and Prettier with `npm run format`.

jest.config.js

@@ -0,0 +1,11 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: [
+    'src/'
+  ],
+  transformIgnorePatterns: ['<rootDir>/node_modules/'],
+  moduleFileExtensions: ['js', 'ts'],
+  maxWorkers: 1,
+};

migrate-mongo-config.js

@@ -4,7 +4,6 @@ const config = {
   mongodb: {
     // TODO Change (or review) the url to your MongoDB:
     url: "mongodb://localhost:27017",
-
     // TODO Change this to your database name:
     databaseName: "volume",
 

organizations.json

@@ -0,0 +1,20 @@
+{
+	"organizations": [{
+			"bio": "",
+			"name": "Women in Stem at Cornell",
+			"slug": "wicc",
+			"websiteURL": "https://wicc.cornell.edu/#/"
+		}, {
+			"bio": "",
+			"name": "AppDev",
+			"slug": "appdev",
+			"websiteURL": "https://www.cornellappdev.com/"
+		},
+		{
+			"bio": "",
+			"name": "Badminton Club",
+			"slug": "badminton",
+			"websiteURL": "https://cornellbadminton.com/"
+		}
+	]
+}