csivitu/techex-backend

Website for TechEx 2020!

TechEx Backend

Backend for the TechEx website
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

About The Project

TechEx, CSIVIT's annual workshop series was conducted this year but amidst the corona virus pandemic, it had to be held online. This project is the backend for the website used for TechEx registrations. We provide functionality for signing up as well as referral codes were implemented.

Built With

• Node
• ExpressJs
• MongoDB

Getting Started

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

Prerequisites

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/csivitu/TechEx-Backend

2. Install NPM packages

npm install

Usage

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

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