Skip to content

Repository files navigation

Purvvidyarthi Docs

Purvvidyarthi

Official Documentation for Purvvidyarthi

Comprehensive documentation for administrators, alumni, institutions, developers, and contributors.


🌐 Live Documentation

https://purvvidyarthi-docs.vercel.app/


About

Purvvidyarthi Docs is the official documentation platform for the Purvvidyarthi Alumni Management System.

It provides everything required to understand, configure, integrate, and use the platform effectively.

Whether you're an administrator managing alumni data, an institution onboarding users, or a developer integrating APIs, this documentation serves as the central knowledge base.


Features

  • 📖 Complete User Guides
  • 🚀 Getting Started Documentation
  • 🏫 Institution Setup Guides
  • 👨‍🎓 Alumni Portal Documentation
  • 👨‍💼 Admin Dashboard Documentation
  • 🔐 Authentication Flow
  • ⚙️ Configuration Guides
  • 🔗 Integration Documentation
  • ❓ Frequently Asked Questions
  • 💡 Best Practices
  • 📚 Developer References
  • 🔍 Searchable Documentation

Documentation Sections

  • Introduction
  • Quick Start
  • Installation
  • Authentication
  • Dashboard Overview
  • Alumni Management
  • Events Management
  • Chapters
  • Opportunities
  • User Profiles
  • Notifications
  • Settings
  • APIs
  • Integrations
  • Troubleshooting
  • FAQ

Tech Stack

  • Next.js
  • React
  • TypeScript
  • Tailwind CSS
  • shadcn/ui
  • Radix UI
  • Lucide Icons

Project Structure

.
├── app/
├── components/
├── context/
├── lib/
├── pages/
├── public/
├── styles/
├── next.config.ts
├── package.json
└── README.md

Getting Started

Clone the repository

git clone https://github.com/the-bipu/purvvidyarthi-docs.git

Move into the project

cd purvvidyarthi-docs

Install dependencies

npm install

Start the development server

npm run dev

Open

http://localhost:3000

Build

npm run build

Run production

npm start

Contributing

Contributions are always welcome.

  1. Fork the repository.
  2. Create your feature branch.
  3. Commit your changes.
  4. Push the branch.
  5. Open a Pull Request.

Please ensure all documentation is accurate, well-formatted, and follows the existing writing style.


Reporting Issues

Found an issue?

Please open an issue with:

  • Clear title
  • Description
  • Steps to reproduce
  • Expected behavior
  • Screenshots (if applicable)

License

This project is licensed under the MIT License.

See the LICENSE file for more information.


Maintainer

Bipanshu Kumar

Lead Software Engineer


Related Projects

  • Purvvidyarthi
  • Purvvidyarthi Admin
  • Purvvidyarthi Mobile App
  • Purvvidyarthi API

Support

If you have any questions, suggestions, or encounter issues while using the documentation, feel free to create an issue in this repository.


Made with ❤️ for the Purvvidyarthi Community.

About

Public documentation for Purvvidyarthi, providing user guides, feature documentation, integration details, and technical references to help users and developers get started quickly.

Topics

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages