ADSC Website

Main website for ADSC (Atmiya Developer Students Club). Built with Next.js, this platform showcases events, hackathons, team, and resources for the ADSC community.

Website • Report Bug • Request Feature

---

📋 Table of Contents

• About
• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• API Reference
• Development
  • Project Structure
  • Running Tests
  • Code Style
• Deployment
• Contributing
• Security
• License
• Acknowledgments
• Contributors

📖 About

ADSC Platform is the official website for Atmiya Developer Students Club. It provides:

• Event listings and details
• Hackathon information and resources
• Team member profiles
• Contact and legal information
• Modern UI built with Next.js and Tailwind CSS

Built With

• Next.js - React framework for production
• Tailwind CSS - Utility-first CSS framework
• TypeScript - Typed JavaScript

✨ Features

• 🚀 Events & Hackathons - Discover ongoing and past events, hackathons, and problem statements
• 👥 Team Showcase - Meet the core team and contributors
• 📚 Resources - Access articles, tech stacks, and contact info
• 🌐 Legal & Policies - View privacy, cookies, and terms

🚀 Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v16.0 or higher)
• npm or yarn
• Git

# Verify installations
node --version
npm --version
git --version

Installation

1. Clone the repository

git clone https://github.com/krishna-dharsandia/adsc-platform.git
cd adsc-platform

2. Install dependencies

npm install
# or
yarn install

3. Set up environment variables

cp .env.example .env

Edit .env with your configuration.

4. Run the development server

npm run dev

📚 Usage

Visit https://adsc-atmiya.in to explore events, hackathons, team, and resources. For local development, use npm run dev and access via http://localhost:3000.

📘 API Reference

This project does not expose a public API. All data is managed within the Next.js app.

🔧 Development

Project Structure

adsc-platform/
├── landing-site/           # Main Next.js app
│   ├── app/                # Application routes and pages
│   ├── components/         # React components
│   ├── constants/          # Static data
│   ├── lib/                # Utilities
│   ├── public/             # Static assets
│   ├── types/              # TypeScript types
│   ├── package.json        # Project metadata and dependencies
│   └── ...
├── README.md               # This file

Running Tests

This project does not include automated tests yet.

Code Style

We use ESLint and Prettier for code formatting:

# Lint code
npm run lint

# Fix linting issues
npm run lint:fix

# Format code
npm run format

Building

# Production build
npm run build

🚢 Deployment

Vercel Deployment

This project is optimized for deployment on Vercel:

# Deploy to Vercel
npm run deploy:vercel

Environment Variables

Note: This project does not require any environment variables for local development or deployment at this time.

Variable	Description	Default	Required
NODE_ENV	Environment (development)	development	No
PORT	Server port	3000	No

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Development Process

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Commit Convention

We follow Conventional Commits:

• feat: New features
• fix: Bug fixes
• docs: Documentation changes
• style: Code style changes
• refactor: Code refactoring
• test: Test updates
• chore: Build process or auxiliary tool changes

🔒 Security

Reporting Security Vulnerabilities

Please do not report security vulnerabilities through public GitHub issues. Instead, please report them to our security team at adsc@atmiyauni.ac.in

See SECURITY.md for more information.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Thanks to all contributors
• Next.js and Tailwind CSS for providing excellent tools
• The open source community for inspiration and support

👤 Contributors

---

Made with ❤️ by ADSC