Skip to content

METSOC/metsoc-website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

METSOC GitHub Repository Documentation

Introduction

Welcome to the METSOC (Metallurgy Society) GitHub repository! This repository is managed by the student body of the Metallurgical Engineering department at IIT(BHU), Varanasi. It serves as a hub for collaboration, development, and sharing of resources related to the METSOC project.

Table of Contents

  1. About METSOC
  2. Contribution Guidelines
  3. Project Setup
  4. Additional Resources

About METSOC

The Metallurgy Society (METSOC) is a student body affiliated with the Department of Metallurgical Engineering at IIT(BHU), Varanasi. METSOC plays a crucial role in fostering student-professor involvement within the department and organizing inter-branch activities.

For more information about METSOC and its initiatives, please visit METSOC Official Website.

Contribution Guidelines

We appreciate and welcome contributions from the community to enhance the METSOC project. Please follow these guidelines to contribute effectively.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the repository to your local machine.
  3. Create a new branch for your contributions.
  4. Make your changes and commit them.
  5. Push the changes to your forked repository.
  6. Submit a pull request to the main repository.

Code Style Guidelines

We follow the React Style Guide for writing code in this project. Please ensure your contributions adhere to this style guide.

Reporting Issues

If you encounter any bugs or issues while using the METSOC project, please report them on the GitHub Issues page.

Project Setup

Follow these steps to set up the METSOC project on your local machine.

Forking the Repository

  1. Visit the METSOC repository on GitHub.
  2. Click on the "Fork" button in the top-right corner of the page.

Cloning the Repository

  1. Clone your forked repository to your local machine using the following command:
git clone <your-forked-repository-url>

Installing Required Packages

  1. Navigate to the project directory:
cd metsoc-website
  1. Install all required packages using:
npm install

Running the Project

  1. Run the project using:
npm start

Additional Resources