Table of Contents
SciNexus is a pioneering social media platform designed specifically for researchers and institutions passionate about advancing scientific knowledge. Our platform serves as a dynamic hub where scientists can communicate, collaborate, and exchange ideas seamlessly. From sharing groundbreaking discoveries to publishing research papers, SciNexus empowers scientists to connect with peers worldwide, fostering innovation and accelerating scientific progress.
At SciNexus, we prioritize security and confidentiality, ensuring that sensitive data and research findings remain protected at all times. With robust security measures in place, researchers can engage in discussions and share insights with confidence, knowing their work is safeguarded.
You can access the API documentation through the Swagger-Ui [host]/swagger-ui/index.html
it has an extensive documentation regarding how when and where to use the API.
We have implemented RESTFull API and maintained the flow of instructions with the response itself.
This is a guide to help you set up your project locally. Follow these steps to get a local copy up and running :
Running this project with full functionalities will require:
- Clone the repo
git clone https://github.com/S24-SWER313/project-halfwayginger.git- Install NPM packages
npm install -g maildev- Start The Docker Server
docker-compose up -d- Start The Mail Service
npx maildev- Customize your Database Configuration in
application-properties, This is Default:
spring.jpa.hibernate.ddl-auto=create-drop
spring.jpa.show-sql=true
spring.datasource.username=
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQLDialect
spring.datasource.url=jdbc:mysql://localhost:3306/scinexusdatabase
spring.datasource.password=1234- Email Verification: When a user tries to register, the request will start loading to send an email verification. The user must then go to localhost:1080 to verify the email.
- Research Papers, Articles, and Posts: The platform accommodates three distinct types of media, allowing for diverse content contributions.
- Collaborative Research Papers: Multiple contributors can collaborate on writing research papers, fostering collaborative knowledge creation.
- Two User Types: The platform caters to two primary user categories: Organizations and Academics.
- Academic Affiliation: Academics have the option to be affiliated with an organization, bridging individual and institutional contributions.
- Chat Functionality: Leveraging a NoSQL database and WebSocket technology, the platform offers real-time chat capabilities for seamless communication.
- Journal Interactions: Users can engage interactively with various journals, enhancing user experience and content engagement.
- Opinions: Users can post opinions on journals and engage in recursive discussions, fostering a dynamic and interactive community.
- Robust Security Protocols: The platform implements high-security measures to ensure data integrity, confidentiality, and user trust.
- Bidirectional User Linking: Implementing a follow and follow-back mechanism, users can establish meaningful connections and enhance networking opportunities.
- Push Notifications: Users receive timely push notifications to stay updated on relevant activities and interactions.
- Email Verification: To ensure the authenticity of users and maintain a trusted community, email verification is implemented as a mandatory step in the registration process. you can check that by [host]:1080/
- Additional Features: The platform offers a range of other features designed to enhance user experience, facilitate collaboration, and promote knowledge sharing.
Although this project is not open-source, we value collaboration and welcome contributions from interested individuals. If you would like to suggest updates, enhancements, or fixes to the code base, we encourage you to engage with us in the following ways:
- Direct Communication : Reach out to the project publishers or maintainers directly to discuss your ideas or proposed changes.
- Issue Tracking : If you identify a bug, have an enhancement suggestion, or want to discuss any aspect of the project, please submit an issue in the designated section. We appreciate detailed descriptions and, if possible, proposed solutions or approaches.
- Feature Requests : If you have ideas for new features or improvements that you believe would benefit the project, please share them with us. We evaluate all suggestions and prioritize them based on their potential impact and alignment with the project's goals.
- Code Contributions : While we manage the project internally, there may be opportunities for external collaborators to contribute code or participate in specific tasks. If you're interested in this, please let us know, and we can discuss the details.
Please note that all contributions will be reviewed and may be subject to approval by the project maintainers. We aim to maintain a high standard of quality and coherence in our project, and we appreciate your understanding and cooperation in this regard.
Thank you for your interest in contributing to our project!
Proprietary License
Copyright (c) 2025 SciNexus
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are not permitted. This software and associated documentation files (the "Software") may only be used under the terms and conditions defined by SciNexus Co. Unauthorized reproduction, distribution, or use of the Software or any part thereof is strictly prohibited and may result in severe civil and criminal penalties.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project Link: S24-SWER313/project-halfwayginger: project-halfwayginger created by GitHub Classroom
We extend our heartfelt thanks to the following individuals, organizations, and communities for their invaluable contributions, support, and inspiration:
- Development Team : A special acknowledgment to the core development team for their dedication, expertise, and collaborative spirit in building and enhancing this project.
- Testers and QA Team : We appreciate the efforts of the testing and quality assurance team for identifying issues, ensuring functionality, and improving the overall quality of the project.
- Technical Reviewers : Special thanks to the technical reviewers who have provided valuable feedback, suggestions, and constructive criticism to improve the code quality and project architecture.
- Domain Experts : We acknowledge the contributions of domain experts who have provided insights, guidance, and expertise in relevant fields, enriching the project's content and functionality.
- Early Adopters : Thank you to the early adopters and beta testers who have provided feedback, reported issues, and helped us refine and optimize the project before its official release.
- Community Supporters : We appreciate the ongoing support, engagement, and advocacy from our user community, which motivates us to continuously improve and innovate.
- Financial Supporters : We acknowledge the financial support and sponsorship provided byno one which has enabled us to invest in development, maintenance, and community engagement.
- Grants and Awards : We are grateful for the grants, awards, and recognition received from no one too which have supported our research, development, and outreach efforts.
- I dought that there is someone will read this so if you have read this just send me a hi on my email
- Family Members : Last but certainly not least, we would like to thank our families for their unwavering support, understanding, and patience throughout the demanding phases of the project. TBH: my family were like "You are always on the computer that will not help you in anything" so...
- Friends and Colleagues : Thank you to our friends and colleagues for their encouragement, moral support, and occasional distractions that have helped us maintain balance and perspective during the project's lifecycle.