Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Setup NPM Workspaces and Simplify Install #232

Merged
merged 5 commits into from
May 24, 2024
Merged

Conversation

nilsstreedain
Copy link
Member

Setup NPM Workspaces and Simplify Install

Description

  • Created a root npm project hosting individual npm workspaces for the client and server to optimize installation, scripts, and dependency storage.
  • New primary install script reduces initial setup/deployment.
    • Has single commands for configuration and install.
    • Builds and serves the entire application using npm run start.
    • Shuts down Docker containers upon process termination.
  • Updated READMEs
    • Added new install method to README.md.
    • Cleaned up /client/README.md to focus on client development.
    • Cleaned up /server/README.md to focus on server development.

Fixes # (issue)

Additional Information

See the updated readme's for updated installation methods and processes during review.

Checklist:

Before you submit your Pull Request, please make sure you have completed the following tasks:

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.
  • I have tagged my PR with the appropriate label(s).

@nilsstreedain nilsstreedain added documentation Improvements or additions to documentation enhancement New feature or request dependencies Pull requests that update a dependency file development Updates and modifications to development/deployment tools labels May 24, 2024
@nilsstreedain nilsstreedain self-assigned this May 24, 2024
@nilsstreedain nilsstreedain marked this pull request as ready for review May 24, 2024 05:16
@nilsstreedain nilsstreedain requested review from a team May 24, 2024 05:17
@nilsstreedain nilsstreedain requested a review from a team as a code owner May 24, 2024 05:17
@nilsstreedain nilsstreedain mentioned this pull request May 24, 2024
8 tasks
Copy link
Member

@Justin-Fernbaugh Justin-Fernbaugh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nilsstreedain nilsstreedain added this pull request to the merge queue May 24, 2024
Merged via the queue into dev with commit 0b48edb May 24, 2024
2 checks passed
@nilsstreedain nilsstreedain deleted the redo-workspaces branch May 24, 2024 19:03
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
dependencies Pull requests that update a dependency file development Updates and modifications to development/deployment tools documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants