Skip to content
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

npm run clean and npm run start fails (cross env is not recognised as a command) #852

Closed
siddhant1 opened this issue Mar 1, 2019 · 6 comments

Comments

@siddhant1
Copy link
Contributor

Nature of issue?

  • Found a bug

Details about the bug:

npm run clean and npm run start fails in powershell (Windows)

  • Operating System:
    Steps to reproduce
  1. Run npm run fetch-examples on a new fork

image

@siddhant1 siddhant1 changed the title npm run clean and npm run start (cross env is not recognised as a command) npm run clean and npm run start fails (cross env is not recognised as a command) Mar 1, 2019
@siddhant1
Copy link
Contributor Author

Looks like we have to hit npm install first
I think we should mention it somewhere in readme.md. This should be in readme instead of https://github.com/processing/p5.js-web-editor/blob/master/developer_docs/installation.md

@catarak
Copy link
Member

catarak commented Mar 1, 2019

The installation guide is mentioned in the README, though it's indirect. There's a link to the developer docs, which is the README in developer_docs, which links to the installation guide. Maybe the copy in the root README can be more clear—something like, "contributors, start here!".

@siddhant1
Copy link
Contributor Author

Yeah sure that'll good , I think we should also add a list of starting steps in the readme to make it beginner friendly
Something like this

Setting up the project

This project requires Node.js version >= 8.10 and yarn

Install dependencies
yarn
Run development
yarn start
Deployment
yarn build

@catarak
Copy link
Member

catarak commented Mar 1, 2019

i don't think it should be added to the root README! i had the installation instructions in there for a while, but it got way too long. in my opinion, the point of the root README is to be a landing page for the project, and adding the installation instructions are too detailed.

@siddhant1
Copy link
Contributor Author

So should we make a link saying "contributers here" and link them to the installation instructions.

catarak added a commit that referenced this issue Mar 4, 2019
@catarak
Copy link
Member

catarak commented Mar 4, 2019

i just added another link to CONTRIBUTING.md and the root README. if think it should be clearer, feel free to make a PR, but it's under the section "Get Involved", so i'm not sure how to make it more clear than that.

@catarak catarak closed this as completed Mar 4, 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

No branches or pull requests

2 participants