-
Notifications
You must be signed in to change notification settings - Fork 237
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add missing detail to Updating the Kit Documentation #286
Add missing detail to Updating the Kit Documentation #286
Conversation
npm start | ||
``` | ||
|
||
All being well the prototyping kit application will run as normal. If you see an error after updating, there may have been changes to underlying code that require an extra command to be run before you can start the application. Type the following into your terminal or command prompt: |
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.
I think it would be good if this is consistent with the instructions already in the docs:
install/install-the-kit.md
install/run-the-kit.md
In terminal:
npm start
After the kit has started, you should see a message telling you that the kit is running:
Listening on port 3000 url: http://localhost:3000
If you see an error after updating, you may need to download extra code used by the kit before it can run.
You can get this by running:
npm install
The install may take up to a minute. Whilst installing it may WARN about some items - this is ok. As long as there are no ERRORs you can continue.
In terminal:
npm start
After the kit has started, you should see a message telling you that the kit is running:
Listening on port 3000 url: http://localhost:3000
If you still have an error, you can raise an issue within github or ask in the Slack channel for users of the prototype kit.
Try to provide as much information as you can about the error and the computer you are attempting to run the prototyping kit on.
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.
cc. @edwardhorsford as I'm copy-and-pasting your docs here.
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.
Better to repeat that in context with the upgrade docs or link to it from the documentation I've written?
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.
I don't think its easy to link to this content as it stands, so yeh just copying and pasting for consistency would be good.
I don't think we need the second instance of:
After the kit has started, you should see a message telling you that the kit is running:
Listening on port 3000 url: http://localhost:3000
as we've just said that above
Hi @paulmsmith I've copied these changes over to #316. |
Adds additional step to the documentation for users to run
npm install
as a first pass at fixing any post updating errors.Think this is worth having in? @joelanman @gemmaleigh if so, can it be proof read. :)