Add instructions for Webpack and node project setup #473
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
Co-Authored-By: Jan Hrcek <honza.hrk@gmail.com>
added webpack config instructions and made corrections on other getting started docs
Also update to Dhall 1.27
* filter out files in .spago folder from watch list * add purescript#430 to changelog * Update src/Spago/Build.hs Co-Authored-By: Jan Hrcek <honza.hrk@gmail.com> * fix build by importing split directories * added step-by-step guide to setting up a spago + parcel project to documentation * cleanup * changelog
f-f
reviewed
Oct 29, 2019
README.md
Outdated
|
|
||
| 12. To run a production build, you can simply run `npm run build` and to start a production process, call `npm start` | ||
|
|
||
| For publishing CLI programs or npm modules, please refer to the npm documentation |
There was a problem hiding this comment.
It might be nice to add a link to the relevant sections of the documentation mentioned here so people don't risk getting lost
README.md
Outdated
| @@ -710,7 +713,7 @@ To start a project using Spago and Parcel together, here's the cammands and file | |||
| 3. Move to the project folder: `cd <project folder name>` | |||
| 4. Create your PureScript project with Spago: `spago init`, This also produces a `./src/Main.purs` file which contains some starter code. | |||
| 5. Initialize the JavaScript/NPM project `npm init` | |||
| 6. Install Parcel as a dependency `npm i parcel` | |||
| 6. Install Parcel as a dependency `npm i parcel` (this is usually a dev dependancy, add the `--save-dev` flag to prevent installation in production or CI environments) | |||
There was a problem hiding this comment.
Suggested change
| 6. Install Parcel as a dependency `npm i parcel` (this is usually a dev dependancy, add the `--save-dev` flag to prevent installation in production or CI environments) | |
| 6. Install Parcel as a dependency `npm i --save-dev parcel` |
We can probably just give users the ready command without much explanation here
|
I believe each of these is now addressed, along with a few typos I caught. |
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.
Description of the change
TODO
Checklist:
READMEP.S.: the above checks are not compulsory to get a change merged, so you may skip them. However, taking care of them will result in less work for the maintainers and will be much appreciated 😊