@foss.global/foss.global

Documentation for @foss.global/foss.global

readme.md for @foss.global/foss.global

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

Prerequisites

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

changelog.md for @foss.global/foss.global

2025-09-16 - 1.6.3 - fix(dependencies)

Bump dependency and devDependency versions

2025-04-27 - 1.6.2 - fix(readme)

Update README to provide a concise project overview and add a documentation plan

2025-04-26 - 1.6.1 - fix(dependencies)

Upgrade various dependencies and refine service configuration

2024-12-26 - 1.6.0 - feat(ui)

Enhancements to dotglobal-topbar and npm link correction

2024-12-17 - 1.5.0 - feat(web)

Introduce and style new dotglobal-navigation component

2024-12-16 - 1.4.0 - feat(UI)

Enhance UI with top bar and updated styles

2024-12-14 - 1.3.1 - fix(dotglobal-basicinfo)

Refactor 'dotglobal-basicinfo' component styles.

2024-12-14 - 1.3.0 - feat(ui)

UI enhancements and dependency updates.

2024-12-14 - 1.2.0 - feat(web)

Implemented periodic fetching of commit data and updated UI styles

2024-12-14 - 1.1.0 - feat(core)

Enhance web elements and server functionality

2024-12-12 - 1.0.0 - Initial Release

First official release of the project.