Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 2.73 KB

README.md

File metadata and controls

83 lines (60 loc) · 2.73 KB
Raw

Scholarly

Research. Redefined.

Your time as a researcher is valuable.

Let Scholarly lend a hand with literature review. Engaging with research papers has never been more efficient or intuitive.

Core Features (In-progress)

In-line Explanations

  • Provides explanations for highlighted text and cited research papers.
  • Relates explanations to the context of the research, making it easier to understand complex concepts.

Abstract-to-Text Hyperlinks

  • Allows users to click on sentences in the abstract to navigate directly to the detailed sections of the paper.
  • Enhances navigation and saves time by linking abstract points to their respective detailed discussions.

Recommendation Engine

  • Suggests similar papers and ones of interest based on past readings.
  • Predicts impactful papers using machine learning and crowdsourced metrics, helping users stay ahead in their field of research.
  • Bodhi creates an optimal paper reading path to efficiently grasp an area of research

Getting Started

Prerequisites

  • Ensure you have the latest version of Node.js and npm installed.

Installation

  1. Clone the repository: 
    git clone https://github.com/RGBmarya/scholarly.git
  2. Navigate to the scholarly-app directory: 
    cd scholarly/scholarly-app
  3. Install dependencies: 
    npm install

Running the Application

To start the application locally, use the following command:

npm start

This will run the app in development mode. Open http://localhost:3000 to view it in the browser.

Building for Production

To build the app for production, run:

npm run build

This will create an optimized build of the application in the build directory.

Contributing

We welcome contributions from the community! To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -m 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Create a pull request.

Feedback and Ideas

We'd love to hear from you! If you have any feedback, new ideas, or just want to discuss the project, feel free to reach out at [email protected].

License

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

Thank you for using Scholarly! We hope it enhances redfines your research experience. Keep cooking 🍳

❤️ from Mihir, Nikhil, and Albon

Acknowledgments

Special thanks to everyone who has contributed to the development of Scholarly. Your support and feedback are invaluable.