Skip to content

README.md

Latest commit

 

History

History
161 lines (107 loc) · 4.04 KB

README.md

File metadata and controls

161 lines (107 loc) · 4.04 KB
Raw

IETE Amrita SF Website 🚀

Official website for the IETE Amrita Student Forum (IETE Amrita SF). This application is built using Next.js to deliver a modern, dynamic, and responsive experience. 🌐✨

Project Overview 📌

The IETE Amrita Student Forum Website aims to:

  • Showcase 🏆 the organization's ongoing and past projects, upcoming events, and key initiatives.
  • Provide an intuitive, responsive user interface 📱💻 for members, alumni, and the public to explore verticals, achievements, and community updates.
  • Enable seamless navigation 🧭 to CP leaderboards, testimonials, blogs, and other essential sections via a dynamic platform.
  • Promote community engagement 💬 through real-time updates and integrated event management tools.

Table of Contents 📖

  1. Screenshots 📷
  2. Getting Started 🚀
  3. Installation 💾
  4. Usage 🛠️
  5. Commit Guidelines ✅
  6. Technologies Used 💡
  7. Using next/font/local for Custom Fonts 🎨
  8. Learn More 📚
  9. Deploy on Vercel 🚀
  10. Contributing 🤝
  11. How to make a Blog 📝
  12. Contributors 🎉

Screenshots 📸

Landing Landing-About

About Section

About-1 About-2

Events and Projects

Events Projects

Teams

Teams Page

Blogs

BLog-1 Blog-2

Getting Started 🚀

To run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Visit http://localhost:3000 in your browser to view the application. 🌍

Installation 💾

  1. Clone the repository: 🖥️

    git clone https://github.com/IETEAmritaChapter/IETE-AmritaSF-Website.git
cd IETE-AmritaSF-Website

  2. Install dependencies: 📦

    npm install
# or
yarn install

Usage 🛠️

  • Start Development Server: 🚀

    npm run dev

  • Build for Production: 📦

    npm run build

    Run the production build:

    npm start

Commit Guidelines ✅

Web Dev Team Note ⚙️

  • This project uses Commitlint to enforce proper commit message standards. 📝

Steps to Commit Changes 🔄

  1. Stage your changes: 📌

    git add <files>

  2. Commit using npx cz: 📝

    npx cz

Technologies Used 💡

  • Next.js ⚡: Framework for server-side rendering and static site generation.
  • React ⚛️: Library for building user interfaces.
  • Tailwind CSS 🎨: Utility-first CSS framework for rapid design.
  • Node.js 🟢: JavaScript runtime environment.

Deploy on Vercel 🚀

Easily deploy this Next.js app via Vercel. 🌎

Contributors 🎉

Made with 🧡 by IETE Amrita SF Team 🎯