This is the README file for the Cross Species Mappper project. It provides a webapp for an interactive mapper which transforms the cognitive ontology between humans and macaques to provide translational exploration.
To install the project for local development, follow these steps:
- Clone the repository to your local machine.
- From the
frontenddirectory, install the required dependencies usingnpm install. - Install
poetrywithpip install poetry. - From the api directory, install the required dependencies with
poetry install. - Start the frontend server by going into the
frontenddirectory and typingnpm run dev. - Start the api server by going into the
apidirectory and typingpoetry run uvicorn src.main:app --reload.
The intended usage of this repository is through its Docker Compose.
- Install Docker Compose if you haven't already. You can download it from the Docker website.
- From the root directory of the project, run docker-compose up to start the application. This will build and start all of the services defined in the docker-compose.yml file.
- Access the frontend by navigating to http://localhost:3000 in your web browser.
- Access the API OpenAPI specification by navigating to http://localhost:8000/docs in your web browser.
The architecture of this project is fairly small. It uses a Svelte frontend for displaying the webpage. This frontend communicates with an API based on Python's FastAPI.
flowchart TD
Svelte <--> FastAPI
FastAPI <--> Azure[Azure Blob]
Before contributing, please see our contribution guidelines in CONTRIBUTING.md in the root of this repository. To contribute to the project, follow these steps.
- Fork the repository.
- Create a new branch for your changes.
- Make your changes and commit them.
- Push your changes to your fork.
- Submit a pull request to the main repository.
This project is licensed under the L-GPL V2.1 license. See the LICENSE file for details.