[Code] Miscellaneous minor changes

albincorreya commented 2 years ago

A list of minor changes and additions that could be done to the repository.

[x] Add a .gitignore and .npmignore file at the root directory of the repository. .idea could be potentially added to both files.
[x] Update README or documentation with some instructions for local development setup. Eg: how to run tests, how to install dependencies etc
[x] What is the purpose of this script? Is it part of the library or is it a 3rd party library? You could delete this file or if you add it here, please also include the LICENSE for it.

MichaelSel commented 2 years ago

Added .gitignore and .npmignore. I updated the readme as you suggested.

The script you are referring to is a 3rd-party library ONLY used when edo.js is deployed in the browser (hence why it's not part of the package.json) and is used to create vector graphics. What do you think is the best practice in this case? Should I remove the script and somehow add the client-side dependency? (never done this before), or should I leave the script where it is and add the license?

albincorreya commented 2 years ago

Added .gitignore and .npmignore.

You also need to add the dist directory to the .gitiignore file since you don't want to push your library release in the git repo. This is because each time you update them we'll end up with more items in the git history, causing it to grow larger and larger. You are already publishing it to NPM and can also use GitHub release functionality for distributing it. Btw, I can see the .idea folder in the repo. Maybe you might want to remove it online.

The script you are referring to is a 3rd-party library ONLY used when edo.js is deployed in the browser (hence why it's not part of the package.json) and is used to create vector graphics. What do you think is the best practice in this case? Should I remove the script and somehow add the client-side dependency? (never done this before), or should I leave the script where it is and add the license?

I can see that this external library raphael.js is not on NPM. In that case, you can leave it in the repo with a license note somewhere. But maybe also rename the directory to libs or something since scripts doesn't semantically make sense here. I leave it up to you to decide.

MichaelSel commented 2 years ago

Added dist to .gitignore Removed dist and .idea from repo. Changed folder name to libs and added license for 3rd party script

MichaelSel commented 2 years ago

Should this issue be closed?

MichaelSel / edoJS

[Code] Miscellaneous minor changes #14