💡 Keener

The backend of an application that lets helps students make the most out of their study groups.

Getting started

We use npm for dependency management.

npm install
npm install --only=dev

To run the application, you need to first compile the TypeScript source code into JavaScript, then run the JavaScript. We have a few scripts to help with this.

npm run build
npm run start

After running the application, you should be able to view activity on localhost:5000.

For development purposes, you can run our dev script to have nodemon watch the src directory and restart the application whenever any changes are saved.

npm run dev

Environment Configuration

We use dontenv for easy configuration of environment variables. Create a file named .env in the root of your clone of the repository that looks like this:

PORT=5000