-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
34 additions
and
5 deletions.
There are no files selected for viewing
This file contains 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 +1 @@ | ||
# All reusable components | ||
# All basic components being reused in multiple places in the app |
This file contains 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 +1,20 @@ | ||
# App-specific features (ie header, left panel, Visualizer (uses core), widgets, etc) | ||
# App-specific features | ||
|
||
A feature is self-contained. It contains everything inside its subdirectories except for any shared components which will be in `components/`. | ||
|
||
ex. | ||
|
||
``` | ||
features/ | ||
Editor/ | ||
Visualizer/ | ||
... | ||
SidePanel/ | ||
... | ||
VisualizerNav/ | ||
... | ||
... | ||
``` | ||
|
||
Here we have the Editor as a feature. To make the Editor work, the Visualizer, SidePanels, and the VisualizerNav are all necessary to make the Editor work. | ||
Any Buttons, Icons, etc will be generic and imported from `components/`. |
This file contains 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 +1,3 @@ | ||
# Shared (“global”) level hooks (ie. project creation/fetching/etc, workspace deleting/etc, etc) | ||
# Global hooks | ||
|
||
Hooks that will be used in multiple places throughout the source code. An example would be a project creation callback that wraps the GraphQL mutation and any default arguments we don't want to repeat in many places. |
This file contains 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 +1,4 @@ | ||
# The main page components (single files, simple)(dashboard, classic editor, experimental, published visualizer, settings) | ||
# Top-level components | ||
|
||
The main pages of the app. They should be single files (`hooks.ts` files only if completely necessary) and simple. | ||
Here is where we will wrap in the Auth provider when necessary and build up the page from its features. |
This file contains 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 +1,3 @@ | ||
# Utility functions used throughout the app | ||
# Utility functions used throughout the app | ||
|
||
Any utils that are not used in multiple places don't need to go here. |
This file contains 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,3 @@ | ||
# Classic Re:Earth UI and functionality | ||
|
||
In mostly maintenance mode. Bug fixes and stability might be merged, but this section of the source code will be relatively unchanged moving forward. |