Mekanika Website

Welcome to the Mekanika website design README! This document provides an overview of the features, hierarchy, pages, and more for the Mekanika website.

How to Clone the Mekanika Website Repository, Make Changes, and Create a Pull Request

1. Fork the Repository

• Go to the Mekanika Website Repository.
• Click the Fork button in the top-right corner to create a copy under your account.

2. Clone the Forked Repository

• Click the green Code button, copy the URL, and run this command in your terminal:

  git clone https://github.com/your-username/Mekanika_website.git

• Replace your-username with your GitHub username.

3. Navigate to the Project Directory

cd Mekanika_website

4. Install Dependencies

After cloning, you need to install the project dependencies by running:

npm install

5.Sync with the Latest Changes to Avoid Conflicts

Before making any changes, always pull the latest changes from the original repository to avoid conflicts:

git remote add upstream https://github.com/jeevan10017/Mekanika_website.git
git pull upstream main

6. Create a New Branch, Make Changes, Commit, and Push

Create a new branch:

git checkout -b your-branch-name

Make your changes in the code, then add and commit them:

git add .

git commit -m "Description of the changes made"

Push your changes to your forked repository:

git push origin your-branch-name

7. Create a Pull Request

Visit your forked repository on GitHub. Click the Compare & pull request button. Add a description, Photos and Videos and submit the pull request.

8.Sync Regularly to Avoid Conflicts

Keep your branch up to date by pulling the latest changes from the original repository as you work:

git pull upstream main

Features

1. Home Page:

3. About Us Page: Provides detailed information about Mekanika, its mission, and its team.

5. Events Page: Displays past events organized by Mekanika, allowing users to learn more and register.

7. Course Materials Page: Access to course materials for mechanical engineering students from semesters 1 to 8.

9. Projects Page: Showcases various projects undertaken by the Mechanical Engineering Dept Professors at IIT KGP, providing details and updates.

8. Blogs Page: Contains two series of blogs: INTERN-CHRONICLES and CORE-EXPEDITION by students who got internships in the department.

Hierarchy

• Home
  • Carousel with images and brief information
  • About Us Section
  • Quick Links
• About Us
  • Detailed information about Mekanika
  • Team member profile
  • Quick Links
• Blogs
  • Two series of blogs: Intern-Chronicles and Core-Expedition.
  • Collection of insightful blog posts
  • Quick Links
• Events
  • Displaying Past Events
  • Quick Links
• Course Materials
  • Accessible course materials for mechanical engineering topics from Semester 1 to 8
  • Quick Links
• Projects
  • Showcase of ongoing and past projects of Professors
  • Quick Links

Pages

1. Home Page
2. About Us Page
3. Blogs Page
4. Events Page
5. Course Materials Page
6. Projects Page

Technologies Used

• React.js: Frontend framework for building user interfaces.
• React Router: Library for handling navigation and routing in React applications.
• FontAwesome: Icon library for adding icons to the website.
• CSS: Styling language used for designing the website layout and appearance.
• Material UI: Component library for dynamic and modern styling.
• Fuse.js: Library for fuzzy search implementation.
• Speech Recognition API: For voice input in search functionality.
• HTML: Markup language used for structuring the web pages.
• JavaScript: Programming language used for adding interactivity and dynamic behavior to the website.
• Node.js: JavaScript runtime environment used for server-side scripting.
• npm: Package manager for installing and managing project dependencies.
• Git: Version control system for tracking changes in the project codebase.
• GitHub: Hosting platform for managing and sharing Git repositories.
• Visual Studio Code: Code editor used for writing and editing code files.

These technologies were instrumental in developing the Mekanika website, providing the necessary tools and frameworks for building a modern and interactive web experience.

Contributors

• Jeevan Kumar Korra

License

This project is licensed under the MIT License.