Skip to content

Latest commit

 

History

History
86 lines (57 loc) · 2.78 KB

File metadata and controls

86 lines (57 loc) · 2.78 KB

Posters.science Developer Documentation

License: MIT VitePress

Developer documentation for the Posters.science platform - a free, open-source solution for creating, sharing, and discovering scientific posters.

About Posters.science

Posters.science is developed by the FAIR Data Innovations Hub to provide a comprehensive platform for scientific poster management. The platform focuses on:

  • FAIR Compliance: Ensuring findability, accessibility, interoperability, and reusability
  • Open Source: Free and accessible to the scientific community
  • AI-Ready: Structured metadata for enhanced discovery
  • Repository Integration: Works with established repositories like Zenodo and Figshare

Documentation Structure

This documentation covers:

Getting Started

Prerequisites

  • Node.js 22.18.0 (managed via Volta)
  • Yarn 1.22.22

Installation

# Clone the repository
git clone https://github.com/fairdataihub/posters-science-dev-docs.git
cd posters-science-dev-docs

# Install dependencies
yarn install

Development

# Start development server
yarn dev

# Or with custom port
yarn docs:dev --port 3000

The documentation will be available at http://localhost:3000 or your custom port if you specified one.

Building

# Build for production
yarn docs:build

# Preview production build
yarn docs:preview

Technology Stack

Contributing

We welcome contributions! Please see our main repository for contribution guidelines.

License

This project is licensed under the MIT License.

Links