Skip to content

SukritDeb/Nexus-Chapter-Website

 
 

Repository files navigation

MLSA Nexus Chapter Website

Welcome to the MLSA Nexus Chapter Website repository! 🎉
This project is built using Next.js with TypeScript for type safety and Tailwind CSS for styling. It’s designed to be a dynamic, community-driven platform where Microsoft Learn Student Ambassadors (MLSA) can share resources, announce events, and foster collaboration.

Figma Link for reference

https://www.figma.com/design/9EePKTLQQBEbIW1FtQKXJJ/Nexus-Website


🚀 Tech Stack

  • Next.js: React-based framework using the App Router for a modular structure.
  • TypeScript: Superset of JavaScript that adds static typing.
  • Tailwind CSS: Utility-first CSS framework for custom UI styling.
  • API Integration: (Optional) APIs for fetching chapter updates, event details, etc.

🎃 Hacktoberfest 2024 Collaboration

We are thrilled to announce that MLSA Nexus Chapter Website is part of Hacktoberfest 2024! Hacktoberfest is a month-long celebration of open-source software, and we welcome all contributors, from beginners to seasoned developers, to join us and help make this repository even better.

🛠️ Installation and Setup

Prerequisites

Before you start, make sure you have the following installed:

  • Node.js (>= 14.x)
  • npm

Clone the Repository

git clone https://github.com/Microsoft-LSA-Nexus-Chapter/Nexus-Chapter-Website
cd Nexus-Chapter-Website

Install Dependencies

npm install

Running the Development Server

npm run dev

It will open at https:/localhost/3000

Project Structure

|src/
    ├── app/                # App Router, entry point for Next.js routes
       ├── layout.tsx      # Layout component for all pages
       ├── page.tsx        # Home page component
       ├── events/         # Events section with nested routes
       └── about/          # About section with static content
    ├── components/         # Reusable components (Header, Footer, etc.)
├── public/             # Static files like images and icons
    ├── images/
├── styles/             # Global styles and Tailwind configuration
├── tsconfig.json       # TypeScript configuration
└── tailwind.config.js  # Tailwind CSS configuration

App Router

The App Router (app/) is where all of the routing happens. Instead of a traditional pages/ directory, each folder inside app/ acts as a route. You can also nest routes easily within this structure.

📢 Important Note

All contributions must adhere to the Hacktoberfest Rules to be counted as valid contributions. This includes ensuring meaningful pull requests and avoiding spammy or incomplete submissions.

📚 Resources

If you're new to open-source or want to learn more about contributing, here are some helpful links:

How to Contribute to open Source

GitHub Documentation

Hacktoberfest Participation Guide

If you're new to Next.js, TypeScript, or Tailwind CSS, check out these resources:

Next.js Documentation

TypeScript Documentation

Tailwind CSS Documentation

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 73.8%
  • CSS 16.9%
  • JavaScript 9.3%