/web-frontend

TSG New Website Frontend

Primary LanguageJavaScript

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

TSG Site Frontend

A backend which caters all the client applications of TSG

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Inventory System Screen Shot

This is an api-based backend started by the Tech Team of gymkhana during 2021 - 2022.

This backend caters to the following applications:

  • TSG Website
  • Inventory Management System
  • ApnaInsti Website
  • ApnaInsti Application

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

This project has been built with the following technologies.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This section contains the prerequisites you need, to use the software and how to install them.

Installation

  1. Clone the repo 
    git clone https://github.com/tsg-iitkgp/web-frontend.git
  2. Install NPM packages 
    npm install
  3. Start the application 
    npm run electron:serve

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

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 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Contact

Praneeth Reddy - @praneethrdy - tech.tsgiitkgp@gmail.com

Project Link: https://github.com/tsg-iitkgp/web-frontend

Acknowledgements