aparna03dubey / anveshan-website

Anveshan Website

Welcome to the official website of Anveshan, the annual fest organized by the Metallurgy Department at the Indian Institute of Technology (BHU), Varanasi. Anveshan is a celebration of innovation, exploration, and excellence in the field of metallurgy. This website is maintained by MetSoc (Student Org)

Prerequisites

Before running the Vite React website, ensure you have the following installed:

• Node.js (recommended version)
• Yarn (optional but recommended)

Tech Stack

• React (v18)
• Firebase

Installation

1. Clone this repository to your local machine:

   git clone <repository-url>

2. Navigate to the project directory:

   cd <project-directory>

3. Install dependencies using Yarn:

   yarn install

Running the Development Server

To run the development server and start coding:

yarn dev

This command starts the development server and serves your project. By default, you can access your site at http://localhost:5173.

Building for Production

To build your project for production, run:

yarn build

This command builds your project for production in the dist directory.

Folder Structure

The folder structure of this project is as follows:

• public: Contains static assets like HTML files, images, and fonts.
• src: Contains the React components, styles, and other frontend-related code.

Contributing

If you would like to contribute to this project, please follow the standard GitHub flow:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.