This repository is dedicated to enhancing the search functionality of the NFDI4BioImage training website by collecting and organizing training materials and related resources.
The project leverages several key technologies:
To simplify the setup process, the project is containerized with Docker. Follow these steps to get the search engine up and running on your local machine.
GitHub API Key or Token: The search engine requires access to GitHub for submitting and managing materials. Ensure that you have set up the necessary GitHub API keys or tokens on your machine.
Docker and Docker Compose installed on your machine.
Currently, this project is only supported on Windows.
Clone the repository:
git clone https://github.com/NFDI4BIOIMAGE/nfdi_search_engine.git
cd nfdi_search_engine
Locate the docker-compose.yml
file in the project directory.
Build and start the containers:
docker-compose up --build
This command will pull all necessary images, build the project, and start the containers.
Once the Docker containers are running, you can access the application:
Search Engine Interface: Visit the website on http://localhost:3000
to use the search engine. You'll see a user-friendly interface where you can search and explore the available training materials. Here's a preview of how the search engine looks:
Submit Materials: The project also includes a material submission platform that makes it easy for users to contribute new training materials. Simply visit http://localhost:3000/submit-materials
and follow the instructions to upload new content.
Search Engine: Find all the current training materials available on the NFDI4BioImage training website with easy-to-use search functionality.
Material Submission: A streamlined process for collecting and managing training materials via the submission portal.
If you'd like to contribute to the project, feel free to open an issue or submit a pull request.