diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ce209b --- /dev/null +++ b/README.md @@ -0,0 +1,81 @@ +# Dev Club Portal 🚀 + +[![Deployment Status](https://img.shields.io/badge/deployment-live-success)](https://portal-aryanvbw.vercel.app/) +[![Version](https://img.shields.io/badge/version-1.1.0-blue)](https://github.com/AryanVBW/Portal/releases) +[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE) + +## 🌟 Deployment Repository + +This is the deployment repository for the Dev Club Portal, optimized for Vercel deployment. For contributing to the project, please visit our [organization repository](https://github.com/nst-sdc/DevCoin). + +### 🔗 Important Links +- 🌐 [Live Demo](https://portal-aryanvbw.vercel.app/) +- 🏢 [Organization Repo](https://github.com/nst-sdc/DevCoin) +- 📚 [Documentation](./PROJECT_DOCUMENTATION.md) +- 📋 [Latest Release Notes](./RELEASE_v1.1.0.md) + +## 🚀 Quick Deploy + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FAryanVBW%2FPortal) + +## 🔄 Repository Structure + +This repository is synchronized with the organization repository [nst-sdc/DevCoin](https://github.com/nst-sdc/DevCoin) and is specifically maintained for deployment purposes. Here's why: + +1. **Vercel Deployment**: Optimized for direct deployment on Vercel's platform +2. **Build Configuration**: Contains specific build and environment settings +3. **Production Ready**: Always maintains a stable, deployment-ready state + +## 🛠️ Setup for Development + +```bash +# Clone this repository +git clone https://github.com/AryanVBW/Portal.git + +# Install dependencies +npm install + +# Start development server +npm run dev + +# Build for production +npm run build +``` + +## 🔄 Sync with Organization Repo + +This repository is regularly synchronized with the organization repository. To contribute: + +1. Visit [nst-sdc/DevCoin](https://github.com/nst-sdc/DevCoin) +2. Make your contributions there +3. Changes will be synchronized to this deployment repo after review + +## 📱 Features + +- 👤 User Authentication & Profiles +- 🏆 DevCoins Leaderboard +- 👥 Member Management +- 📊 Contribution Tracking +- 🔐 Admin Dashboard +- 🖼️ Custom Avatar System + +## 🤝 Contributing + +For contributions, please use our [organization repository](https://github.com/nst-sdc/DevCoin). This repository is primarily for deployment purposes. + +## 📞 Support & Contact + +- **Developer**: Vivek W +- **Email**: vivek.aryanvbw@gmail.com +- **GitHub**: [@AryanVBW](https://github.com/AryanVBW) + +## 📄 License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +--- + +