Skip to content

[FR] Separate the pro-file code from calub-web #13

Description

@njncalub

Description

In order for users to create their own CV, there should be a separate package for the pro-file app. This package should also be available in the NPM registry, and should export the dev, build, and export commands.

The only remaining files in the calub-web directory should be the pro-file.yaml file, the public/ assets directory, and custom component types (e.g. the logo in the divider component).

Motivation

It would be easier for users to use and contribute to the project if it's decoupled from the rest of the code.

Suggested Implementation

  • Create a separate monorepo that only holds files related to the pro-file project.
  • There should also be a GitHub Page for the documentation.
  • Since this will allow for public contributions, additional community files should be added. Check this guide for more details.
  • Unit tests and Storybook setup should be added.

End result will allow users to do this:

npm install -g pro-file
pro-file (dev|build|export) [-f my-config.yaml]

Alternate Implementations

  • It's possible to move it to another directory for now (e.g. apps/pro-file). That way, it will not break things on development while the code is not yet completely decoupled.
  • Code can directly be copied to the new repo. After everything is working correctly, replace usage in the calub-web project with the live one from the npm registry.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions