Skip to content

techvillaLnct/Techvilla-Web

Repository files navigation

📚 TechVilla

Welcome to TechVilla Coding Club — Empowering the Next Generation of Developers. We believe in Code. Create. Contribute. Our goal is to foster an inclusive and collaborative developer community.

🚀 Project Overview

This is TechVilla's web platform designed to support developers by providing access to resources, events, and a strong network of like-minded individuals. Join us in our mission to empower the next generation of developers.


📋 Table of Contents


✨ Features

  • 🌐 Responsive Design: Mobile-first, fast, and sleek UI.
  • 📚 Resources Hub: Access developer resources like articles, videos, and tools.
  • 📅 Events & Hackathons: Stay updated on the latest events, hackathons, and workshops.
  • 👥 Team Section: Meet the minds behind TechVilla.
  • 🔥 Interactive UI: Hover effects, animations, and a smooth user experience.

🛠️ Tech Stack

Frontend:

  • Next.js (React Framework)
  • Tailwind CSS (Responsive Styling)

Other Tools:

  • Vercel (Deployment)

Future Updates:

  • Next Auth
  • Adding Database probably Mongodb or Firebase

🏁 Getting Started

Follow these steps to set up TechVilla's Website locally.

Prerequisites

Make sure you have the following installed:

  • Node.js (v16 or higher)
  • Git

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/techvilla.git
    cd techvilla
  2. Install dependencies:

    npm install
  3. Run the development server:

    npm run dev
  4. Open in your browser: Open http://localhost:3000 in your browser to see the live version.


📁 Project Structure

techvilla/
├── public/          # Static files (images, icons, etc.)
├── app/             # Source files (components, pages, styles, etc.)
│   ├── layout.tsx/  # Project metadata and script
│   ├── page.tsx/       # Next.js pages (home, team, resources, etc.)
│   ├── global.css/      # Global and component styles
├── components     # Project all ui components
├── lib/     # utils files
    ├── utils.tsx/
├── package.json     # Project metadata and scripts
├── tailwand.config.json     # Tailwand data
└── README.md        # This file

🤝 How to Contribute

We welcome contributions from the community! Follow the steps below to get started.

🛠️ Contributing Steps

  1. Fork the repository (click the "Fork" button at the top-right of this page).
  2. Clone your fork:
    git clone https://github.com/techvillaLnct/Techvilla-Web.git
    cd techvilla
  3. Create a new branch for your feature or bugfix:
    git checkout -b feature/your-feature-name
  4. Make changes and test them.
  5. Commit your changes:
    git add .
    git commit -m "feat: Add a concise, clear commit message"
  6. Push to your fork:
    git push origin feature/your-feature-name
  7. Create a Pull Request (PR) on the main repository.

👀 What to Contribute?

  • Bug fixes: Spot an issue? Help us squash it!
  • New features: Have an idea? Create it and send a PR!
  • Documentation: Improve the README, guides, and tutorials.
  • Code optimization: Help us make our code better.

💡 Contribution Tips

  • Keep pull requests small and focused.
  • Write clear, descriptive commit messages.
  • Run tests before submitting a PR.

🧭 Code of Conduct

Our goal is to create a welcoming, inclusive environment for all contributors. Please follow these simple guidelines:

  • Be respectful of others' work.
  • Provide constructive feedback.
  • Avoid inappropriate language or behavior.

By participating, you agree to abide by our Code of Conduct.


📜 License

This project is licensed under the MIT License — you're free to use, modify, and distribute it as you wish. See the LICENSE file for more details.


💬 Get in Touch

We'd love to have you on board! Feel free to raise an issue, contribute, or simply join the conversation.


Happy Coding! 🚀