Skip to content

mukulsharma15/AlumniConnect

Repository files navigation

Updated

README.md

# AlumniConnect

AlumniConnect is a web application designed to help manage the alumni of an institute. It provides a platform for alumni to connect, share achievements, and access institutional resources. The application includes features such as tracking academic and professional history, showcasing achievements, and integrating social media tools.

## Features

- **Achievements**: Track and showcase alumni achievements across diverse domains.
- **Social Media**: Engage and interact with alumni via integrated social media tools.
- **Academic History**: Access and manage academic milestones with ease.
- **Professional History**: Network and discover opportunities through alumni career paths.

## Team

Meet the amazing team behind AlumniConnect:

- **Mukul**: Mastermind
  - Mukul acts tough, is a softie, annoys everyone, and after 21 days of lagging, still aces tests like a genius.
- **Manvendra**: Know-It-All
  - Manvendra is the know-it-all who always has the answers and keeps the team on track.
- **Bhoomi**: The Connector
  - Bhoomi is the one who brings everyone together, ensuring smooth communication and collaboration.
- **Binwant**: The Innovator
  - Binwant is always coming up with new ideas and solutions to improve the project.

## Links to Other Documents

- [Project Documentation](docs/project_documentation.md)
- [Team Contributions](docs/team_contributions.md)
[final_triggers](docs/final_triggers.md)
- [final_procedure_explanation](docs/final_procedure_explanation.md)

## Getting Started

To get started with AlumniConnect, follow these steps:

1. Clone the repository:
   ```sh
   git clone https://github.com/yourusername/alumniconnect.git
  1. Setup Virtual environment:

    python3 -m venv venv
    • For Unix-like systems (Linux, macOS):

      source venv/bin/activate
    • For Windows:

      .\venv\Scripts\activate
  2. Navigate to the project directory:

    cd alumniconnect
  3. Install the required dependencies:

    pip install -r requirements.txt
  4. Apply the migrations:

    python manage.py migrate
  5. Run the development server:

    python manage.py runserver
  6. Open your browser and navigate to http://127.0.0.1:8000/ to access the application.

Contributing

We welcome contributions from the community. To contribute to AlumniConnect, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes and commit them with a clear message.
  4. Push your changes to your fork.
  5. Create a pull request to the main repository.

License

This project is licensed under the MIT License. See the LICENSE file for more details.


### Explanation

- **Project Description**: Added a brief description of the project and its features.
- **Team Details**: Included details about the team members and their roles.
- **Links to Other Documents**: Added links to other markdown files for project documentation and team contributions.
- **Getting Started**: Provided steps to get started with the project.
- **Contributing**: Included instructions for contributing to the project.
- **License**: Mentioned the license for the project.

This updated 

README.md

 provides a comprehensive overview of your project, team details, and additional resources.

About

AlumniConnect is a webapp which helps in management of Alumni of an Institue

Resources

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •