Skip to content

Consider a monorepo for Atomic-Data-Browser and Rust #216

Closed
@joepio

Description

@joepio

We have:

  • atomic-data-docs, containing just documentation. The goal of the issue tracker is to discuss the spec. It should probably be kept separate for this reason.
  • atomic-data-rust, containing atomic-server, a CLI and a rust library. These are highly interdependent (or at least, cli and server depend on lib)
  • atomic-data-browser, which also contains the react and typescript libraries.

Reasons to combine atomic-data-rust and atomic-data-typescript in a single repo:

  • Easier to perform integration tests / CI with multiple changing parts
  • Easier to contain the host browser assets in the server Host the data-browser assets / JS bundles #185
  • Better discoverability of other parts of the stack
  • Users might find it easier to drop an issue in one repo, instead of having to decide which part is failing if they see an error.

Reasons not to:

  • The project will be seen more as one big stack, instead of as a modular stack with an open standard
  • Issues for both front-end and back-end will be less separated.

Steps:

  • Move open PRs
  • Move issues https://jloh.co/posts/bulk-migrate-issues-github-cli/
  • Move data
  • Combine github actions / workflows
  • Remove build_server.sh script
  • Move Github Site for @tomic/lib NPM TS docs
  • Update Browser readme
  • Update Server readme
  • Update Contribute.md
  • Update gitignore
  • Fix docker build
  • Fix release script

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions