jkunz 7094912d6f
Docker (tags) / security (push) Failing after 1s
Docker (tags) / test (push) Has been skipped
Docker (tags) / release (push) Has been skipped
Docker (tags) / metadata (push) Has been skipped
v1.7.0
2026-06-23 15:29:49 +00:00
2024-12-12 00:42:41 +01:00
2024-12-12 00:42:41 +01:00
2026-06-23 15:29:49 +00:00
2026-06-23 15:29:49 +00:00
2026-06-23 15:29:49 +00:00
2024-12-12 00:42:41 +01:00
2024-12-12 00:42:41 +01:00
2024-12-12 00:42:41 +01:00
2024-12-12 00:42:41 +01:00
2026-06-23 15:29:49 +00:00
2024-12-12 00:42:41 +01:00
2024-12-12 00:42:41 +01:00
2024-12-12 00:42:41 +01:00

foss.global

Official codebase for the foss.global website, built with TypeScript and the @api.global ecosystem.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Prerequisites

  • Node.js (>=20)
  • pnpm
  • MongoDB connection for SmartData-backed public snapshots
  • MONGODB_URL/MONGODB_URI/MONGO_URL for the MongoDB connection URL
  • Optional MONGODB_DATABASE/MONGODB_DB/MONGO_DB override; defaults to foss_global

Installation

pnpm install

Build

Compile TypeScript and bundle the website:

pnpm build

Watch

Rebuild on file changes:

pnpm watch

Start

Start the CLI web server:

pnpm start

Start using the TypeScript entrypoint:

pnpm run startTs

Usage Example

After starting the server, open your browser at http://localhost:3000 to view the site and API.

Testing

Currently no automated tests are defined. The pnpm test command runs the build process.

Project Structure

./
├── ts/             # CLI source files
├── ts_web/         # Frontend source files
├── html/           # Static HTML templates
├── assets/         # Static assets (images, styles, etc.)
├── dist_ts/        # Compiled CLI output
├── dist_serve/     # Bundled website for serving
├── cli.js          # Node.js CLI entrypoint
├── cli.ts.js       # TypeScript CLI entrypoint
└── readme.md       # Project README

Module/Plugin Import Guidelines

CLI code imports modules via a central plugin file:

import * as plugins from './ffb.plugins.js';

Web code generally imports directly from packages or uses ts_web/plugins.ts when applicable.

Contributing

Contributions are welcome! To contribute:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/YourFeature)
  3. Commit your changes (git commit -m "Add awesome feature")
  4. Push to your fork (git push origin feature/YourFeature)
  5. Open a pull request against the main branch

Please follow the existing code style and run pnpm build before submitting.

License

This project is UNLICENSED. See package.json for details.

Contact / Support

S
Description
No description provided
Readme 490 KiB
Languages
TypeScript 98.9%
HTML 0.7%
Dockerfile 0.3%