Skip to content

Commit

Permalink
docs: Update README with deployment-specific information
Browse files Browse the repository at this point in the history
- Add deployment repository context
- Explain relationship with organization repo
- Add quick deploy button
- Update setup instructions
  • Loading branch information
AryanVBW committed Jan 6, 2025
1 parent 9e82b35 commit ee66a41
Showing 1 changed file with 81 additions and 0 deletions.
81 changes: 81 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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**: [email protected]
- **GitHub**: [@AryanVBW](https://github.com/AryanVBW)

## πŸ“„ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

<div align="center">
<h3>🌟 Star us on GitHub β€” it motivates us a lot! 🌟</h3>
<em>Made with ❀️ by NST-SDC Dev Club</em>
</div>

0 comments on commit ee66a41

Please sign in to comment.