Getting Started - Outlined different options for app setup #17
Conversation
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
Collaborator
theangchen
commented
Aug 9, 2024
theangchen
commented
- Scaffolding an app
- Scaffolding with 1 Example
- Get all the examples
- Help option
jaygiang
reviewed
Aug 10, 2024
| @@ -18,9 +18,19 @@ npm start | |||
|
|
|||
| Then open [http://localhost:3000/](http://localhost:3000/) to see your app. | |||
|
|
|||
| **Option 2:** If you would like to scaffold from 1 example, please see [Running an Example](./building-your-application/available-scripts/running-example.md) | |||
|
|
|||
| **Option 3:** You can also clone the boilerplate repo to get all the examples. Then run `npm i` followed by `npm start` from the example directory you want to run. | |||
There was a problem hiding this comment.
Maybe can can link https://github.com/NMFS-RADFish/boilerplate to boilerplate repo text so it's easier for the reader to find
jaygiang
reviewed
Aug 10, 2024
| @@ -18,9 +18,19 @@ npm start | |||
|
|
|||
| Then open [http://localhost:3000/](http://localhost:3000/) to see your app. | |||
|
|
|||
| **Option 2:** If you would like to scaffold from 1 example, please see [Running an Example](./building-your-application/available-scripts/running-example.md) | |||
|
|
|||
| **Option 3:** You can also clone the boilerplate repo to get all the examples. Then run `npm i` followed by `npm start` from the example directory you want to run. | |||
There was a problem hiding this comment.
The instructions are a bit misleading. To run an example project, you'll actually need to:
- cd in
examplesfolder - cd into an example
ex. computed-form-fields, main, etc. - run
npm i - run
npm start
jaygiang
reviewed
Aug 10, 2024
| ```bash | ||
| npx @nmfs-radfish/create-radfish-app my-app --help | ||
| ``` | ||
|
|
||
| # Creating an PWA |
There was a problem hiding this comment.
Found a typo! We should change Creating an PWA to Creating a PWA.
jaygiang
approved these changes
Aug 10, 2024
There was a problem hiding this comment.
@theangchen Looks great!
Just added a couple of suggestions/potential changes. Good to merge after those changes! ✅
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.