Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 4.08 KB

README.md

File metadata and controls

120 lines (81 loc) · 4.08 KB
Raw

Offical Documentation for MLSC VCET Website

Overview

Welcome to the official documentation for the MLSC VCET Website, the dynamic and immersive website created by the Web Team! where you can Immerse yourself in seminars, hackathons, and interactive workshops where we showcase our projects, engage in vibrant discussions, and unleash our tech potential.

📦 Technologies Used

  • Vite
  • React.js
  • Three.js
  • GSAP
  • Firebase
  • Netlify

Running the MLSC VCET Website Locally

To run the MLSC VCET Website locally, follow the guidelines below. Ensure that you have Node.js and npm installed on your machine.

Prerequisites

  • Node.js: Make sure Node.js is installed. You can download it from here.

Steps

  1. Clone the repository:

    git clone https://github.com/Microsoft-Learn-Students-Club/MLSC-website.git

  2. Navigate to the project directory:

    cd MLSC-website

  3. Install Dependencies:

    npm install

  4. Run the application:

    npm run dev

    This command will start the development server and open the app in your default web browser.

  5. Access the App: Open your web browser and go to http://localhost:5173. You should see the MLSC VCET Website in React + Vite.js app running locally.

  6. Explore the App: You can now explore the different sections of the MLSC VCET Website, such as Home, Works, Team, Leaderboard and Contact Us.

  7. Stop the Development Server: To stop the development server, press Ctrl + C in the terminal where the server is running.

Additional Notes

  • If you encounter any issues with dependencies, ensure that Node.js and npm are properly installed, and try running npm install again.
  • Make sure the required npm packages are listed in the package.json file.
  • For deployment or production builds, you may need to refer to the specific deployment instructions or build scripts provided in the project.

Contribution Guidelines

We welcome contributions to enhance the MLSC VCET website. Your input is valuable, and following these guidelines ensures a smooth collaboration.

Getting Started

  1. Fork & Clone: Begin by forking the repository and cloning it to your local machine.

    git clone https://github.com/your-username/MLSC-website.git
cd MLSC-website

  2. Environment Setup: Set up your development environment and install necessary dependencies.

    npm install

  3. Branching: Create a new branch for your feature or bug fix.

    git checkout -b feature/your-feature-name

Code Style

  • Follow consistent coding styles and conventions.
  • Ensure meaningful variable and function names.
  • Maintain proper indentation.

Commit Messages

  • Write clear and concise commit messages.
  • Use present tense and imperative mood (e.g., "Add feature" instead of "Added feature").

Reporting Issues

  • If you encounter any issues or bugs, please report them on the GitHub Issues page. Provide a detailed description, steps to reproduce, and relevant information.

Testing

  • Before submitting a pull request, ensure thorough testing of your changes. Verify that the existing functionality remains intact.

Pull Requests

  • Create Pull Request: Develop a pull request against the main branch of the original repository.
  • Description: Clearly describe the changes and the motivation behind them.
  • Reference Issues: If applicable, reference any related issues in your pull request.

Questions

  • If you have any questions, feel free to reach out to the maintainers or the community for assistance.

Thank you for contributing! 🌟

Maintainers

The MLSC VCET Website is actively maintained and developed by the following contributors:

Feel free to contact the maintainers for support, bug reports, or contributions to the project. We appreciate your interest and collaboration!