How to implement SJCL in any angular project is unclear

bitwiseshiftleft / sjcl

Stanford Javascript Crypto Library

http://bitwiseshiftleft.github.com/sjcl/

Other

7.18k stars 986 forks source link

How to implement SJCL in any angular project is unclear #388

Open offline-pixel opened 5 years ago

offline-pixel commented 5 years ago

Hi , This side front-dev. I came across your SJCL, it looks great after reading. However, How to implement in angular project is quite unclear... or due to lack of documentation, i am unclear to implement in angular project with version 5 or latest

I am practicing on angular/JavaScript and novice to programming after reading about this SJCL and their contributors. Please help me out

robyoder commented 5 years ago

Hi, @deepak-ranolia. GitHub issues are generally not the best place to ask for help with something. I'd suggest asking on stackoverflow.com. When you do, try to be as specific as possible. For example, what have you tried doing so far and what isn't working?

offline-pixel commented 5 years ago

Hi @robyoder. thanks however you are contributors which can make the documentation on "Implement SJCL in angular project" As this is particularly for client side general purpose symmetric crypto library.

while your documentation is only limited to expert developers and SJCL npm has no docs at all

Also posted on https://stackoverflow.com/questions/55412462/warning-in-node-modules-sjcl-sjcl-js-while-using-sjcl-angular-7

raymondboswel commented 3 years ago

@offline-pixel For anyone who might come across this:

Add the minified script to your assets directory.
Add the path to the script in angular.json > scripts: ['path/to/sjcl.js']
In a service.ts file: declare var sjcl: any;
Now you can use the lib in your service.

ismaelharunid commented 3 years ago

Well the responses are not wrong. Typically people get what they need from looking at the code, examples or tests. However typically there is at least a one or two line installation section and a one r two line instruction on verify it's installed correctly and working at least minimally. I think add these 6 to 8 lines would be greatly appreciated by everyone new coming to the repo. For myself, I also found it a bit disconcerting but I found my way within 12 minutes. Just my two cents. The demo actually fulfill this, if it is mentioned in the readme.md that would almost be enough.