Feat/Meta Information & Documentation (#47)

* chore: meta tags added

* chore: code documentation added

* chore: readme file updated

* chore: contributing guide updated

CONTRIBUTING.md

@@ -1 +1,47 @@
+# Contributing to Xilinx Nexus SRM Website
 
+Thank you for considering contributing to Xilinx Nexus SRM Website! This document provides some guidelines to help you get started.
+
+## Getting Started
+
+Before contributing to Xilinx Nexus SRM Website, please ensure that you have read and understood our [README.md](README.md) file.
+
+## How to Contribute
+
+Contributions can be made to the website in the following ways:
+
+- Reporting a bug
+- Submitting a feature request
+- Proposing a code change
+
+### Reporting Bugs
+
+If you encounter any bugs or issues while using the website, please open a new issue in our [issue tracker](https://github.com/kunalkeshan/Xilinx-Homepage/issues) and include the following details:
+
+- A clear and descriptive title
+- A description of the issue
+- Steps to reproduce the issue
+- Expected and actual behavior
+
+### Submitting a Feature Request
+
+If you have an idea for a new feature or improvement to the website, please open a new issue in our [issue tracker](https://github.com/kunalkeshan/Xilinx-Homepage/issues) and include the following details:
+
+- A clear and descriptive title
+- A description of the feature or improvement
+- Why this feature or improvement would be useful
+
+### Proposing a Code Change
+
+If you would like to propose a code change, please follow these steps:
+
+1. Fork the repository and create a new branch.
+2. Make your changes and commit them to your branch.
+3. Test your changes thoroughly.
+4. Submit a pull request.
+
+When submitting a pull request, please ensure that you include a clear and descriptive title and description of your changes.
+
+## License
+
+By contributing to Xilinx Nexus SRM Website, you agree that your contributions will be licensed under the [MIT License](LICENSE).

README.md

@@ -1,3 +1,80 @@
-Reference Design: https://allora.webflow.io/#work
+# Xilinx Nexus SRM
 
-Data Referece: https://faisalnazir7.github.io/xilinxSRM/index.html
+<p align="center">
+    <img src="./public/images/thumbnail.png" alt="Xilinx Nexus SRM" width="60%" />
+</p>
+
+**Table of Contents**:
+
+- [Preface](#-preface)
+- [Getting Started](#-getting-started)
+  - [Clone this Repository](#clone-this-repository)
+  - [Install Packages & Dependencies](#installing-packages--dependencies)
+  - [Start Application](#start-application)
+- [Contributing](#-contributing)
+  - [Project Contributors](#project-contributors)
+- [License](#-license)
+
+## 💡 Preface
+
+The Xilinx NEXUS is a program initiated by SRMIST to support Women in Technology (WIT) programs within the university. This innovative program is made possible by grants from Xilinx, Inc.
+
+This static website is developed using React, Typescript and Tailwind CSS.
+
+## 🚀 Getting Started
+
+### Clone this Repository
+
+```bash
+git clone https://github.com/kunalkeshan/Xilinx-Homepage.git
+```
+
+### Installing Packages & Dependencies
+
+- Install using Yarn.
+
+```bash
+yarn
+```
+
+- Install using NPM.
+
+```bash
+npm install
+```
+
+### Start Application
+
+Start using Yarn.
+
+```bash
+yarn start
+```
+
+Start using NPM.
+
+```bash
+npm start
+```
+
+## 🤖 Contributing
+
+Anybody is free to contribute to this repo. If you think that you can improve the model or the gui, follow the contributing guidelines mentioned at [CONTRIBUTING.md](/CONTRIBUTING.md)
+
+### Project Contributors
+
+<a href="https://github.com/kunalkeshan/Xilinx-Homepage/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=kunalkeshan/Xilinx-Homepage" />
+</a>
+
+## 🔐 License
+
+This project is licensed under the [MIT License](/LICENSE).
+
+### Forking this Repo?
+
+Many people have contacted us asking if they can use this code for their own websites. The answer to that question is usually "yes", with attribution. There are some cases, such as using this code for a business or something that is greater than a personal project, that we may be less comfortable saying yes to. If in doubt, please don't hesitate to ask us.
+
+We value keeping this project open source, but as you all know, plagiarism is bad. We actively spend a non-negligible amount of effort developing, designing, and trying to perfect this iteration of our project, and we are proud of it! All we ask is to not claim this effort as your own.
+
+So, feel free to fork this repo. If you do, please just give us proper credit by linking back to this repo, [https://github.com/kunalkeshan/Xilinx-Homepage](https://github.com/kunalkeshan/Xilinx-Homepage). Refer to this handy [quora](https://github.com/kunalkeshan/Xilinx-Homepage) post if you're not sure what to do. Thanks!

index.html

@@ -11,6 +11,40 @@
 			rel="stylesheet"
 		/>
 		<title>Xilinx Nexus SRM</title>
+		<meta
+			name="title"
+			content="Xilinx Nexus SRM - Towards Technical Empowerment"
+		/>
+		<meta
+			name="description"
+			content="The Xilinx NEXUS is a novel initiative of SRMIST, made possible by grants from Xilinx, Inc. It aims to support Women in Technology (WIT) programs within the university, by providing the necessary funding."
+		/>
+
+		<!-- Open Graph / Facebook -->
+		<meta property="og:type" content="website" />
+		<meta property="og:url" content="https://xilinxsrm.netlify.app/" />
+		<meta
+			property="og:title"
+			content="Xilinx Nexus SRM - Towards Technical Empowerment"
+		/>
+		<meta
+			property="og:description"
+			content="The Xilinx NEXUS is a novel initiative of SRMIST, made possible by grants from Xilinx, Inc. It aims to support Women in Technology (WIT) programs within the university, by providing the necessary funding."
+		/>
+		<meta property="og:image" content="/images/thumbnail.png" />
+
+		<!-- Twitter -->
+		<meta property="twitter:card" content="summary_large_image" />
+		<meta property="twitter:url" content="https://xilinxsrm.netlify.app/" />
+		<meta
+			property="twitter:title"
+			content="Xilinx Nexus SRM - Towards Technical Empowerment"
+		/>
+		<meta
+			property="twitter:description"
+			content="The Xilinx NEXUS is a novel initiative of SRMIST, made possible by grants from Xilinx, Inc. It aims to support Women in Technology (WIT) programs within the university, by providing the necessary funding."
+		/>
+		<meta property="twitter:image" content="/images/thumbnail.png" />
 	</head>
 	<body>
 		<div id="root"></div>

src/components/cards/EventCard.tsx

@@ -1,3 +1,7 @@
+/**
+ * Event Card Component
+ */
+
 import React from 'react';
 import { Event } from '../../data/events';
 

src/components/cards/GalleryImageCard.tsx

@@ -1,3 +1,7 @@
+/**
+ * Gallery Image Card Component
+ */
+
 import React from 'react';
 import { Image } from '../../data/gallery';
 

src/components/cards/GoalCard.tsx

@@ -1,3 +1,7 @@
+/**
+ * Goal Card Component
+ */
+
 import React from 'react';
 import { IMission } from '../../data/goals';
 

src/components/cards/MemberCard.tsx

@@ -1,3 +1,7 @@
+/**
+ * Member Card Component
+ */
+
 import React from 'react';
 import { TeamMember } from '../../data/team';
 import { FaGlobe, FaInstagram, FaTwitter, FaLinkedinIn } from 'react-icons/fa';

src/components/home/FellowMembers.tsx

@@ -1,3 +1,7 @@
+/**
+ * Fellow Members Component
+ */
+
 import { TEAM } from '../../data/team';
 import MemberCard from '../cards/MemberCard';
 

src/components/home/Goals.tsx

@@ -1,7 +1,11 @@
+/**
+ * Goals Component
+ * Includes Vision and Mission.
+ */
+
 import { VISION, MISSION } from '../../data/goals';
 import GoalCard from '../cards/GoalCard';
 
-// Includes Vision and Mission.
 const Goals = () => {
 	return (
 		<section className='w-full min-h-fit max-w-7xl mx-auto mt-16'>

src/components/home/Intro.tsx

@@ -1,3 +1,7 @@
+/**
+ * Intro Component
+ */
+
 import Lottie from 'lottie-react';
 import WomenInTechAnimationData from '../../assets/lottie/women-in-tech.json';
 import { Link } from 'react-router-dom';

src/components/home/ProjectHighlight.tsx

@@ -1,3 +1,7 @@
+/**
+ * Project Highlight Component
+ */
+
 import Lottie from 'lottie-react';
 import HardwareAnimationData from '../../assets/lottie/hardware-animation.json';
 import { FaGithub } from 'react-icons/fa';

src/components/home/YouTubeEmbed.tsx

@@ -1,3 +1,7 @@
+/**
+ * YouTube Embed Component
+ */
+
 import React from 'react';
 
 interface YouTubeEmbedProps {

src/components/layouts/Footer.tsx

@@ -1,3 +1,7 @@
+/**
+ * Footer Component
+ */
+
 import { FOOTER_LINKS } from '../../data/navigation';
 import { Link } from 'react-router-dom';
 

src/components/layouts/Navbar.tsx

@@ -1,3 +1,7 @@
+/**
+ * Navbar Component
+ */
+
 import { useState } from 'react';
 import Headroom from 'react-headroom';
 import { GiHamburgerMenu } from 'react-icons/gi';

src/pages/Gallery.tsx

@@ -1,3 +1,7 @@
+/**
+ * Gallery Page
+ */
+
 import GalleryImageCard from '../components/cards/GalleryImageCard';
 import { IMAGES } from '../data/gallery';
 

src/pages/Home.tsx

@@ -1,3 +1,7 @@
+/**
+ * Home Page
+ */
+
 import FellowMembers from '../components/home/FellowMembers';
 import Goals from '../components/home/Goals';
 import Intro from '../components/home/Intro';

src/pages/NotFound.tsx

@@ -1,3 +1,7 @@
+/**
+ * Not Found Page
+ */
+
 import { Link } from 'react-router-dom';
 
 const NotFoundPage = () => {

src/pages/Research.tsx

@@ -1,3 +1,7 @@
+/**
+ * Research Page
+ */
+
 import ProjectHighlight from '../components/home/ProjectHighlight';
 
 const ResearchPage = () => {

src/pages/Team.tsx

@@ -1,3 +1,7 @@
+/**
+ * Full Team Page
+ */
+
 import { TEAM } from '../data/team';
 import MemberCard from '../components/cards/MemberCard';
 

src/pages/events/EAndTEducation.tsx

@@ -1,3 +1,7 @@
+/**
+ * Engineering & Technology Education Event Page
+ */
+
 const EAndTEducationEventPage = () => {
 	const ACTIVITIES = [
 		'Design flow using Xilinx tools ( hardware and software)',

src/pages/events/PolytechnicStudents.tsx

@@ -1,3 +1,7 @@
+/**
+ * Polytechnic Students Event Page
+ */
+
 const PolytechnicStudentsEventsPage = () => {
 	const ACTIVITIES = [
 		{

src/pages/events/StemProgramme.tsx

@@ -1,3 +1,7 @@
+/**
+ * STEM Porgramme Event Page
+ */
+
 const StemProgrammeEventPage = () => {
 	const FACULTIES_PRESENT = [
 		'Dr. Vasantha Dev Suryakala Assistant Professor/ECE',

src/pages/events/index.tsx

@@ -1,3 +1,7 @@
+/**
+ * All Events Page
+ */
+
 import { EVENTS } from '../../data/events';
 import EventCard from '../../components/cards/EventCard';