forked from AryanVBW/Portal
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Update README with deployment-specific information
- Add deployment repository context - Explain relationship with organization repo - Add quick deploy button - Update setup instructions
- Loading branch information
Showing
1 changed file
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |