CodeGolf-Backend

Backend repository for CSI-VITs CodeGolf platform.

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
• Roadmap
• Contributing
• License
• Contributors ✨

About The Project

This repository contains the code for CSI-VIT's codebash platform - CodeGolf, written in Node.js, MongoDB and Javascript.

Built With

• Node.js
• MongoDB

Getting Started

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

1. Clone the repository

    git clone https://github.com/AJ1479/CodeGolf-Backend.git

2. Install NPM packages

npm install

3. Start the server

npm start

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.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

ashikka 💻 📖

AJ1479 💻 📖

Subham Subhasish Panda 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!