README.rst: Add Build and Development instructions by KVGarg · Pull Request #153 · coala/coala-html

KVGarg · 2019-01-13T12:43:57Z

The commit adds instructions for running coala-html on a local system.

Closes #135

README.rst

shashank-b

Also, refer the issue in the commit message as well.

README.rst

utkarsh2102

Hey,
Did you try following these steps and are these working for you?

KVGarg · 2019-01-15T00:29:34Z

Yea i followed these steps and they were working perfectly fine for me, Also i have send these instructions to one of my friends to cross verify it that whether he is facing any issues during installation of coala-html on Ubuntu or not, but he didn’t faced any issues 🙂

KVGarg · 2019-01-17T04:37:54Z

@frextrite @shashank-b Please review the latest commit

README.rst

KVGarg · 2019-01-17T14:41:16Z

@frextrite reply to comment
it won't work.
Made some suggested changes, need review 😄

KVGarg · 2019-01-17T16:23:45Z

@frextrite @shashank-b can you guys help me out in solving this issue as it is related to this issue only ?

README.rst

KVGarg · 2019-01-26T08:45:51Z

@li-boxuan @frextrite @shashank-b Kindly review latest commits, tq

README.rst

jayvdb · 2019-01-30T08:16:15Z

README.rst

+
+     ::
+
+       $ sudo chown -R $USER:$GROUP ~/.config/configstore


Sorry if my review repeats things already in old reviews,...

This step is a non-standard step -- there is no reason why this directory should have strange permissions.

The problem is possibly caused by sudo npm install -g bower, but I am not sure about that.

Anyways ... you added it here for a reason ... i'd love to know why, so we can look at how to avoid it.

Actually, when we try to run coala-html --dir ./coala_test_results it install the bower components that are required to build up a static website and it is a package used by AngularJS, that is possible only if it has write access to configstore
and, to install bower using npm it needs write access that's why i used sudo

Using asdf solves those sudo problems.

Ok, will try out them and if everything goes well, will use asdf.

@jayvdb asdf has solved the problem of sudo npm install -g bower but wasn't able to solve the problem sudo chown -R $USER:$GROUP ~/.config/configstore
It still need permissons to access the files in the configstore folder.
npm suggests a ownership command sudo chown -R $USER:$(id -gn $USER) ~/.config/configstore, we can change the above command to this one

@KVGarg , if you never run 'sudo' in your install steps, the chown is not necessary.

redo your steps without running 'sudo'. and show me errors that you can not fix. chown is not the solution - it is a workaround recommended by npm because they do not recommend asdf, and so their workaround is not acceptable to us.

@jayvdb I'm wondering that earlier it wasn't getting installed due to write access to configstore but now it is getting installed easily without even using sudo. Removing this instruction from guide.

jayvdb · 2019-01-30T08:20:02Z

README.rst

+          ::
+
+           $ sudo apt-get install curl python-software-properties
+           $ curl -sL https://deb.nodesource.com/setup_11.x | sudo bash -


doesnt ubuntu have node? Above a "Node.js PPA" is mentioned, but this is not a PPA.

We should give a PPA install method.

Also for generic Linux, and even Windows, I am now recommending that we use @asdf-vm in our instructions, as it allows installing of node and python and anything else we need. (not sure about bower / lets check that)

This section is meant for Linux users, sorry my bad.
I will change to Linux in both the headings where it is written for Ubuntu/Linux users.

PPA install method

Should I change above heading to this one ?

doesnt ubuntu have node?

Need to run sudo apt install nodejs to install nodejs

@jayvdb And, should I add installation instructions according to @asdf-vm in current instructions or a provide a link somewhere in instruction either at end or at the beginning of instructions ?

A link to official upstream pages is better.

I have added link for installing nodejs via asdf-vm. Will it work? or should I add offical nodejs website link for installing it ?

README.rst

gitmate-bot added process/pending review difficulty/low size/XS labels Jan 13, 2019

gitmate-bot assigned KVGarg Jan 13, 2019

frextrite suggested changes Jan 14, 2019

View reviewed changes

shashank-b suggested changes Jan 14, 2019

View reviewed changes

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

shashank-b suggested changes Jan 14, 2019

View reviewed changes

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

utkarsh2102 reviewed Jan 14, 2019

View reviewed changes

KVGarg force-pushed the build_development_instructions branch from c87bb33 to 8a05f53 Compare January 16, 2019 16:52

gitmate-bot added size/S and removed size/XS labels Jan 16, 2019

KVGarg force-pushed the build_development_instructions branch from 8a05f53 to 7e2ebcd Compare January 16, 2019 18:04

frextrite suggested changes Jan 17, 2019

View reviewed changes

KVGarg force-pushed the build_development_instructions branch 3 times, most recently from f68f813 to d65bf6b Compare January 17, 2019 14:53

frextrite suggested changes Jan 18, 2019

View reviewed changes

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

KVGarg force-pushed the build_development_instructions branch from d65bf6b to a03b3fa Compare January 18, 2019 16:48

frextrite suggested changes Jan 22, 2019

View reviewed changes

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

KVGarg force-pushed the build_development_instructions branch 3 times, most recently from 4055e4a to e66a039 Compare January 22, 2019 10:34

frextrite suggested changes Jan 26, 2019

View reviewed changes

README.rst Outdated Show resolved Hide resolved

KVGarg force-pushed the build_development_instructions branch from e66a039 to 5ed25ad Compare January 27, 2019 10:04

jayvdb requested changes Jan 30, 2019

View reviewed changes

jayvdb reviewed Jan 30, 2019

View reviewed changes

README.rst Show resolved Hide resolved

KVGarg force-pushed the build_development_instructions branch from 5ed25ad to c58beff Compare January 30, 2019 17:10

This comment has been minimized.

Sign in to view

KVGarg force-pushed the build_development_instructions branch from c58beff to c310892 Compare January 31, 2019 20:48

gitmate-bot added size/XS and removed size/S labels Jan 31, 2019

jayvdb added process/wip and removed process/pending review labels Feb 3, 2019

KVGarg force-pushed the build_development_instructions branch from c310892 to f8d84ef Compare February 3, 2019 13:47

gitmate-bot added the process/pending review label Feb 3, 2019

KVGarg force-pushed the build_development_instructions branch from f8d84ef to 0092680 Compare February 3, 2019 15:10

gitmate-bot added size/S and removed size/XS labels Feb 3, 2019

frextrite approved these changes Feb 8, 2019

View reviewed changes

areebbeigh suggested changes Feb 10, 2019

View reviewed changes

README.rst Outdated Show resolved Hide resolved

KVGarg force-pushed the build_development_instructions branch from 0092680 to ac3d514 Compare February 10, 2019 16:38

areebbeigh suggested changes Mar 1, 2019

View reviewed changes

README.rst Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

README.rst: Add Build and Development instructions

4e05c4f

KVGarg force-pushed the build_development_instructions branch from ac3d514 to 4e05c4f Compare March 2, 2019 08:35

li-boxuan removed the process/wip label Mar 27, 2019

Conversation

KVGarg commented Jan 13, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shashank-b left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

utkarsh2102 left a comment

Choose a reason for hiding this comment

Uh oh!

KVGarg commented Jan 15, 2019

Uh oh!

KVGarg commented Jan 17, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

KVGarg commented Jan 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

KVGarg commented Jan 17, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

KVGarg commented Jan 26, 2019

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KVGarg Jan 31, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KVGarg Jan 30, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment has been minimized.

KVGarg commented Jan 17, 2019 •

edited

Loading

KVGarg Jan 31, 2019 •

edited

Loading

KVGarg Jan 30, 2019 •

edited

Loading