Skip to content

Latest commit

 

History

History
99 lines (68 loc) · 3.93 KB

README.md

File metadata and controls

99 lines (68 loc) · 3.93 KB
Raw

Women In Cloud RVCE API (UNOFFICIAL)

Production Maintainability Test Coverage

Unofficial API for Women In Cloud RVCE Center of Excellence Management.

Architecture

Table of Contents

About

Women In Cloud RVCE API provides an unofficial backend service for the Women In Cloud RVCE Android & Web App. It offers various endpoints to manage projects, internships, events, student details, staff registration, and more.

Android App

The Android app is available on the Play Store. Explore it here.

Repository: women-in-cloud-rvce-android

Web App

Repository: women-in-cloud-rvce-web

API Documentation

Base URL

The base URL for API endpoints is https://....

Endpoints

  • /project-applied-students/{project_id}/: Get students who applied for a project.
  • /internship-applied-students/{internship_id}/: Get students who applied for an internship.
  • /event-applied-students/{event_id}/: Get students who applied for an event.
  • /add-project: Add a new project.
  • /add-internship: Add a new internship.
  • /add-event: Add a new event.
  • /hire-project: Hire a student for a project.
  • /hire-internship: Hire a student for an internship.
  • /upload-project-document/{project_id}: Upload project documents.
  • /upload-internship-document/{internship_id}: Upload internship documents.
  • /upload-event-document/{event_id}: Upload event documents.
  • /student: Get student details by USN.
  • /funds: Get funds information.
  • /add-fund: Add a new fund.
  • /students: Get registered students.
  • /all-project-applied-students: Get all students who applied for projects.
  • /all-internship-applied-students: Get all students who applied for internships.
  • /all-event-applied-students: Get all students who applied for events.
  • /register-staff: Register a staff member.
  • /get-staff: Get a list of staff members.
  • /studentsCSV: Get student details in CSV format.

Refer to the Java class diagram and Spring model dependency diagram for an overview of the application's structure.

Environment Variables

Ensure to set the following environment variables:

  • sql_user_name
  • sql_password
  • google_password
  • google_user_name

Contributing

Contributions are welcome! To contribute:

  1. Fork this repository.
  2. Clone the forked repository locally.
  3. Create a new branch for your feature/fix.
  4. Make your changes and commit them.
  5. Push the changes to your fork.
  6. Create a pull request in the original repository.

License

This project is licensed under the MIT License.

Contact

For questions or feedback, feel free to contact us.

Disclaimer: This project is not affiliated with any official Women In Cloud RVCE platforms. It's developed independently for educational and community purposes.