Skip to content

Contributing

Jump to bottom
Allen Shibu edited this page Sep 26, 2023 · 2 revisions

Contributing Guide

We're really excited that you're interested in contributing to Techno Event Management System! Before submitting your contribution, please read through the following guide.

Prerequisites

We expect contributors to have an understanding of how web apps work, REST APIs, TypeScript, NextJS, ExpressJS and SQL. We also expect you to know how to use Git and GitHub.

Before you start

Make sure you have downloaded and installed the latest version of NodeJS and NPM. Click here to download. Also, make sure that you download PNPM as this project uses it. Click here to download PNPM.

Repo Setup

To develop locally, fork the Techno Event Management repository and clone it in your local machine. This repo is a mono repo managed using Turborepo. The package manager used to install and link dependencies must be PNPM.

  1. Copy the .env.example file in web-client to .env.local
  2. Copy the .env.example file in core to .env
  3. Run pnpm i in the root folder.
  4. Run pnpm run dev in the root folder.

The web client will be running in http://localhost:3000 and the serve in http://localhost:3001

Clone this wiki locally