InsightsApp is a powerful tool designed to provide comprehensive insights and analytics for various data sources, with a focus on Semantic Scholars. It is built with a modular architecture to allow easy integration and extension of functionalities.
The backend of InsightsApp is implemented as a RESTful API, providing a robust and scalable infrastructure for data processing and analysis. It leverages the power of Node.js and utilizes PostgreSQL as the database to efficiently store and retrieve data.
On the frontend, InsightsApp offers a rich set of visualizations and interactive interfaces to explore and analyze the data. It is built with Next.js, a popular React framework, which enables fast and responsive user experiences.
With InsightsApp, users can gain valuable insights from Semantic Scholars data, visualize trends and patterns, and make data-driven decisions. Whether it's analyzing research papers, exploring citation networks, or tracking the impact of scientific publications, InsightsApp provides a comprehensive solution for data analysis and visualization.
By combining the power of modular architecture, RESTful API, PostgreSQL, and advanced visualizations, InsightsApp empowers researchers, scientists, and data enthusiasts to unlock the full potential of Semantic Scholars data and gain valuable insights for their projects and research endeavors.
- Modular Architecture: Easily extend and integrate new modules.
- Data Visualization: Comprehensive and interactive data visualization.
Follow these instructions to set up and run the project on your local machine.
- Node.js 21+
- Docker
-
Clone the Repository
git clone --recurse-submodules https://github.com/muhammadtalha242/insightsApp.git cd insightsApp
-
Set Up Environment Variables
Create a
.envfile in thecsinsight_backenddirectory by copying the.env.examplefile and updating the values according to your environment. -
Start the Application
Run the following command to start the application using Docker containers:
docker-compose up
This will build and start the backend and frontend services defined in the
docker-compose.ymlfile. -
Access the Application
Once the application is running, open your browser and navigate to
http://localhost:80to access the frontend interface. From there, you can explore the various features and functionalities of the InsightsApp.
- backend: Contains the Node backend code.
- frontend: Contains the Nextjs frontend code.
Each submodule has its own README file with specific instructions on how to set up and use the submodule.
Once the application is running, open your browser and navigate to http://localhost:80 to access the frontend interface. From there, you can explore the various features and functionalities of the InsightsApp.
Contributions are welcome! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature). - Make your changes.
- Commit your changes (
git commit -m 'Add your message'). - Push to the branch (
git push origin feature/your-feature). - Open a Pull Request.
Please make sure to update tests as appropriate.
This project is licensed under the MIT License - see the LICENSE file for details.