README.md

Research-Nexas 🌟🔬📚

Research-Nexas is a cutting-edge web application designed to create a seamless connection between students, researchers, and stakeholders within a collaborative research ecosystem. The platform empowers students to log in, upload their research papers, view their uploads, and track their evaluations. 🎓📝 They can also access their profile to see their research details and the evaluation criteria set by the stakeholder.

Stakeholders act as research supervisors who can approve student submissions and assign papers to the appropriate faculty members for evaluation. 👩‍🏫📑 Stakeholders also set evaluation criteria, which they can view on their profile. Faculty members, in turn, can review the assigned papers, provide ratings, and evaluate results based on predefined criteria.

This application creates a dynamic, feedback-driven environment where students can improve their research based on faculty evaluations, and stakeholders can ensure quality through customizable criteria. 🌱✨

With Research-Nexas, the future of research collaboration is smarter, faster, and more impactful. 💡📈

🌟 Stars	🍴 Forks	🐛 Issues	🔔 Open PRs	🔕 Close PRs

---

📚 Table of Contents

• Technical Stack
• Prerequisite
• Running Application with Docker
• Future Enhancements / Roadmap
• API Documentation
• License
• Contribution
• Contributors
• Code of Conduct
• 📞 Contact Information

🛠️ Technical Stack

Technology	Description
🌐 Frontend	HTML, CSS, JavaScript (framework/library not specified)
🔙 Backend	Node.js, Express
💾 Database	MySQL
🧪 Version Control	Git
📦 Package Manager	npm
💻 Environment	Docker

Prerequisite

• NPM & Nodejs
• Docker

Run Application with Docker

• Make a .env file under login-system directory and copy these key-values:

    MYSQL_HOST=mysqlcontainer
    MYSQL_USER=user
    MYSQL_ROOT_PASSWORD=password
    MYSQL_PASSWORD=password
    MYSQL_DATABASE=user_DB
    DB_PORT=3306
    PORT=3000
    ACCESS_TOKEN_SECRET=3a9af42de397cfc9387a06972c28c23a1ac7e9a60fb6dc1f05295bc6057baf500672d4a13db5d04ea84bbc4c5679164a7723f3d49f516bb73dc3df6e3b768c8e
    EMAIL=harsh@gmail.com   #youremailid
    MYPASS=yourmailpassword   #your developer mail password
  

• You can find yourmailpassword for low protected app(developer use) here- https://youtu.be/nuD6qNAurVM
• Within root project directory run-
  • Linux:

    sudo docker compose up --build
    

  • Windows:

    docker compose up --build
    

• Click the link shown in terminal or open your browser and search for-

  http://localhost:3000
  

• You can prevent data loss of mysql by mounting your localhost path onto docker container path /var/lib/mysql in the docker compose file under db service. It will prevent any data loss if the container is recreated. Reference: here

  volumes:
     - $LOCALPATH:/var/lib/mysql
  

🛣️ Future Enhancements / Roadmap

🗓️ Timeline	✨ Milestone	📝 Description
Q4 2024	📊 User Dashboard Improvements	Enhance user dashboards with detailed research analytics, including version control for uploaded research papers.
Q1 2025	💬 Enhanced Faculty-Student Interaction	Implement real-time chat and discussion boards for faculty-student collaboration on research topics.
Q2 2025	🤖 Research Evaluation System Enhancements	Introduce AI-based evaluation assistance for grading research papers based on predefined criteria.
Q4 2025	🌍 Internationalization and Localization	Enable multi-language support to expand the platform’s reach to a global audience.
Q1 2026	📚 Publication and Citation Tracking	Integrate publication tracking to help users manage where their papers are published and track citations in real-time.

🚀 Stay tuned for more updates and exciting features!

API Documentation 📚

The Research Nexas application communicates with a backend API to manage various functionalities. Here’s a brief overview of the available API endpoints:

HTTP Method	Endpoint	Description
POST	/api/register	✍️ Registers a new student or stakeholder.
POST	/api/login	🔐 Logs in a user (student, faculty, or stakeholder).
POST	/api/upload	📤 Allows students to upload their research papers.
GET	/api/uploads/:userId	📄 Fetches all uploads for a specific user.
POST	/api/evaluate	⭐ Submits evaluations and ratings from faculty.
GET	/api/criteria/:stkId	📊 Fetches evaluation criteria set by the stakeholder.
POST	/api/criteria	🏷️ Sets evaluation criteria by the stakeholder.
GET	/api/results/:userId	📈 Fetches evaluation results for a specific user.

License 📝

This project is licensed under the MIT License.

Contribution

Welcome to Research Nexas build for researchers, before contributing to the project please go through our contribution guidelines Contributing.md. If you have any doubts about guidelines, please open an issue regarding that , we will help for it. Your PR should follow Contributing.md guidelines.

Contributors

We are grateful to all the contributors who have collaborated on this project. Their efforts, dedication, and creativity have significantly enhanced our work. Below is the list of contributors along with their GitHub profiles:

Contributor	Contributor	Contributor	Contributor
Harshdev098 👨‍💻	Ygowthamr 👨‍💻	Ankitha2130 👩‍💻	Alolika 👩‍💻
T Rahul Prabhu 👨‍💻	Trinetra 👩‍💻	Rishi 👨‍💻	Smog Root 👨‍💻
Harish 👨‍💻	Ragini 👩‍💻	Bhuvaneswari 👩‍💻	Shweta 👩‍💻
Soumya 👩‍💻	Shubham Agarwal 👨‍💻	Mrunal Kashid 👩‍💻	Siri Chandana 👩‍💻
Mitul Sonagara 👨‍💻	Dipanita 👩‍💻	Gaurav 👨‍💻	Anu 👩‍💻
Ishita 👩‍💻	Sudhanshu 👨‍💻	Hamza 👨‍💻	Ajay Singh 👨‍💻
Archana Singh 👩‍💻	Tanya Soni 👩‍💻	Kousthub 👨‍💻	Dinkar 👨‍💻
Sarthak 👨‍💻	Pks 👨‍💻	ADeshmukh 👨‍💻	Ash 👨‍💻

Code of Conduct

This project follows Code of Conduct Star ⭐ the project if you like it,working and contributing with us ❤️.

📞 Contact Information

Project Admin⚡

HARSH DEV PATHAK

Got questions? Want to suggest improvements? Open an issue on GitHub or contact the project admin, Harsh Dev, at:

📧 harshoxfordgkp@gmail.com

---

Big thanks to all the contributors!