https://github.com/fairdataihub/posters-science-dev-docs
Developer documentation for the Posters.science platform
https://github.com/fairdataihub/posters-science-dev-docs
Last synced: 10 months ago
JSON representation
Developer documentation for the Posters.science platform
- Host: GitHub
- URL: https://github.com/fairdataihub/posters-science-dev-docs
- Owner: fairdataihub
- License: mit
- Created: 2025-09-13T00:26:53.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-13T01:34:39.000Z (10 months ago)
- Last Synced: 2025-09-13T03:23:38.553Z (10 months ago)
- Language: TypeScript
- Homepage: https://dev.posters.science
- Size: 66.4 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Posters.science Developer Documentation
[](https://opensource.org/licenses/MIT)
[](https://vitepress.dev/)
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](https://fairdataihub.org/) 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:
- 🏗️ **[Architecture](./architecture/)** - System design and technology stack
- 📤 **[Submission Portal](./submission/)** - Poster upload and processing workflow
- 🔍 **[Discovery Engine](./discovery/)** - Search capabilities and LLM integration
- 📊 **[Monitoring & Analytics](./monitoring/)** - Observability and performance tracking
## Getting Started
### Prerequisites
- Node.js 22.18.0 (managed via Volta)
- Yarn 1.22.22
### Installation
```bash
# Clone the repository
git clone https://github.com/fairdataihub/posters-science-dev-docs.git
cd posters-science-dev-docs
# Install dependencies
yarn install
```
### Development
```bash
# 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
```bash
# Build for production
yarn docs:build
# Preview production build
yarn docs:preview
```
## Technology Stack
- **[VitePress](https://vitepress.dev/)** - Static site generator
- **[Mermaid](https://mermaid.js.org/)** - Diagram generation
- **[Vue 3](https://vuejs.org/)** - Frontend framework
- **[Prettier](https://prettier.io/)** - Code formatting
## Contributing
We welcome contributions! Please see our [main repository](https://github.com/fairdataihub/posters-science) for contribution guidelines.
## License
This project is licensed under the MIT License.
## Links
- **Platform**: [https://posters.science](https://posters.science)
- **Main Repository**: [https://github.com/fairdataihub/posters-science](https://github.com/fairdataihub/posters-science)
- **Issues**: [https://github.com/fairdataihub/posters-science-dev-docs/issues](https://github.com/fairdataihub/posters-science-dev-docs/issues)
- **FAIR Data Innovations Hub**: [https://fairdataihub.org/](https://fairdataihub.org/)