📚 docs(alumniverse): add Software Requirements Specification (SRS) to documentation

This commit is contained in:
sankalp committed 2025-06-15 02:44:49 +05:45
1 parent 2d56e7d8fe
commit 7789733aa3
2 files changed
+18 -16

No files matched your search

+18 -16
View File
@@ -1,27 +1,28 @@
# 🎓 Alumni Network
# 🎓 AlumniVerse
A web-based platform designed to connect, engage, and empower alumni. This project aims to build a strong, lifelong alumni community through user profiles, messaging, events, job opportunities, and more.
## 🚧 Project Status
> **Status**: 🛠 In development
The repository has been initialized. Core architecture, models, and features are currently being designed. Code will be pushed incrementally as development progresses.
> **Status**: 🛠 In development
> The repository has been initialized. Core architecture, models, and features are currently being designed. Code will be pushed incrementally as development progresses.
## 📄 Software Requirements Specification (SRS)
The formal SRS document is currently being prepared and will be uploaded soon. It will include:
- Functional and non-functional requirements
- System architecture
- Feature breakdown
- Technology stack
- Development roadmap
- Functional and non-functional requirements
- System architecture
- Feature breakdown
- Technology stack
- Development roadmap
> 📌 _The SRS will be available in the `/docs` directory or linked here once published._
## 🌟 Planned Features
### Core Features
- Alumni registration and login (with verification)
- Profile management (education, job, contact info)
- Alumni directory with search and filters (batch, program, location)
@@ -29,6 +30,7 @@ The formal SRS document is currently being prepared and will be uploaded soon. I
- Admin panel for managing users and content
### Advanced Features
- Private messaging and group chats
- Job and internship board
- Community posts, forums, and announcements
@@ -38,11 +40,11 @@ The formal SRS document is currently being prepared and will be uploaded soon. I
## 🛠 Tech Stack
- **Frontend**: React + TypeScript
- **Backend**: Django + Django REST Framework
- **Database**: PostgreSQL
- **Authentication**: JWT or OAuth 2.0
- **Dev Tools**: Docker, GitHub Actions, Postman
- **Frontend**: React + TypeScript
- **Backend**: Django + Django REST Framework
- **Database**: PostgreSQL
- **Authentication**: JWT or OAuth 2.0
- **Dev Tools**: Docker, GitHub Actions, Postman
- **Deployment**: Render, Railway, or VPS
## 📁 Folder Structure
@@ -61,12 +63,12 @@ _Will be added once the initial codebase is ready._
## 🤝 Contributing
Contributions are welcome after the initial setup is complete.
Contributions are welcome after the initial setup is complete.
Please follow standard practices and guidelines for AGPL-licensed software.
## ⚖ License
This project is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**.
This project is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**.
See the full license in the [LICENSE](./LICENSE) file.
> 🔐 Under the AGPL, if you deploy this project for public use, you must also make the complete source code publicly available.
@@ -78,6 +80,6 @@ See the full license in the [LICENSE](./LICENSE) file.
---
<sub>
_"A man without aims is like a monkey."_ 🐒
_"A man without aims is like a monkey."_ 🐒
— Sankalp, building one line of code at a time
</sub>
View File
Whitespace-only changes.