Restructure project and add Storybook #84
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| .idea | ||
| node_modules/ | ||
| **/yarn-error.log | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,39 @@ | ||||||
| # Thunderstore UI | ||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| Run `yarn install` at the root of the project, that's it. | ||||||
|
|
||||||
| ## Repository structure | ||||||
|
|
||||||
| This repository is intended to function as a monorepo, which contains several | ||||||
| sub-projects inside it. The goal of this structure is to enable easier code | ||||||
| sharing between projects as well as more efficient and higher coverage test | ||||||
| suites | ||||||
|
|
||||||
| Tools used for enabling this behavior are primarily: | ||||||
|
|
||||||
| - yarn workspaces, as defined in the root `package.json` | ||||||
| - typescript configuration inheritance and path aliases | ||||||
| - tweaks for module resolution done in other tools such as nextjs or webpack, | ||||||
| making sure the path aliased packages are appropriately resolved | ||||||
|
Comment on lines
+16
to
+19
There was a problem hiding this comment. These should probably start with capital letters |
||||||
|
|
||||||
| All sub-projects exist in the `packages` directory, includinig the following: | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ### components | ||||||
|
|
||||||
| This project is intended to house common UI components that can be re-used | ||||||
| across different projects, e.g. the Thunderstore Mod Manager as well as the | ||||||
| website | ||||||
|
|
||||||
| ### nextjs | ||||||
|
|
||||||
| This nextjs-based website project | ||||||
|
|
||||||
|
|
||||||
| ### storybook | ||||||
|
|
||||||
| [storybook](https://storybook.js.org/) is used to make the component catalogue | ||||||
| easier to browse. | ||||||
|
|
||||||
| You can run it with `yarn storybook` within the storybook project, and access it | ||||||
| via localhost at the port provided on the terminal. | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Each project currently ignores their own
node_modules(other than the newstorybookone). These should either be removed from the projects that include it, so it's clear that it is ignored at the root, or added tostorybookand this change should be reverted.