Skip to content

Add instructions for Webpack and node project setup - #473

Merged
f-f merged 21 commits into
purescript:masterfrom
Benjmhart:master
Oct 30, 2019
Merged

f-f merged 21 commits into
purescript:masterfrom
Benjmhart:master

Conversation

@Benjmhart

Copy link
Copy Markdown
Contributor

Description of the change

TODO

Checklist:

  • Added the change to the "Unreleased" section of the changelog
  • Added some example of the new feature to the README
  • Added a test for the contribution (if applicable)

P.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 😊

Comment thread README.md Resolved
Comment thread 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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be nice to add a link to the relevant sections of the documentation mentioned here so people don't risk getting lost

Comment thread README.md Outdated
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)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@Benjmhart

Benjmhart commented Oct 30, 2019 •

Copy link
Copy Markdown
Contributor Author

I believe each of these is now addressed, along with a few typos I caught.

@f-f f-f mentioned this pull request Oct 30, 2019
5 tasks done

@f-f f-f left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Benjmhart! 👏

@f-f
f-f merged commit 8ce19ea into purescript:master Oct 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants