rafaelcascalho/talk-radio-challenge

This is a quake log parser which get games kills counts and rank the server players based on their kill counts.

Talk Radio Challenge

This is a quake log file parser developed for the challenge of talk radio. The log file used currently is based on the email and is in the folder src/data.

API

Here is a link to the api docs.

Prerequisites

⚠️ Required ⚠️

Node current LTS To install node and npm just download it here or follow this tutorial. To check the version run the command

$ node -v
v12.16.1

🚀 Getting started 🚀

Setup

Clone the repository and enter the repository directory

$ git clone git@github.com:rafaelcascalho/talk-radio-challenge.git

$ cd talk-radio-challenge

Install dependencies

To install the project dependencies just run the command

$ npm install

Run :woman_running:

To run the project in the dev environment just run the command

$ npm run dev

🧪 Running the tests 🧪

To run the tests just use the command

$ npm test

Using a different log file

To run the project with a different log file just replace the existent log file in the src/data directory, and name it game.log.

Built With

• Typescript - Typescript as a superset for the node environment
• Ts-node-dev - To restart the node process on file changes
• Express - Express as the http requests handler
• NodeJs - Backend environment for javascript
• Jest - Automated tests library
• Prettier - Code formatter
• Editorconfig - Code style enforcer