csivitu / ForkThis2023-Backend

ForkThis 2023 Backend

ForkThis is a Git/Github workshop and the above code is the backend for the competition website
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributors

About The Project

Backend used for ForkThis's competition. Features like GitHub Auth, a leaderboard system where the points are automatically added when a pull request is merged through webhooks

Built With

• Express
• Typescript
• MongoDB
• webhooks

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/csivitu/Template.git

2. Install NPM packages

npm install

3. Start the app in dev mode

npm run start

License

Distributed under the MIT License. See LICENSE for more information.