fix: updated instruction for local setup in mac OS #76
Conversation
Subhash703
force-pushed
the
fix/setup-instruction
branch
2 times, most recently
from
aef5519 to
7c0dc6e
Compare
docs/setup.md
Outdated
| - make sure you have dependencies like libpq, openssl, libiconv, diesel_clietc installed | ||
| - To install these dependencies run the following commands - | ||
| ```bash | ||
| brew install libpq # Add libpq to the path |
There was a problem hiding this comment.
@Subhash703 can we add linux specific instructions too?
There was a problem hiding this comment.
@Datron @Subhash703 - that can come in a separate PR too - because the Linux instructions might depend on distro sometimes. Let us get the Mac instructions merged if they look good.
docs/setup.md
Outdated
| - make sure you have dependencies like libpq, openssl, libiconv, diesel_clietc installed | ||
| - To install these dependencies run the following commands - | ||
| ```bash | ||
| brew install libpq # Add libpq to the path |
There was a problem hiding this comment.
Can we make a single brew command to install all deps to reduce the number of steps?
Subhash703
force-pushed
the
fix/setup-instruction
branch
from
7c0dc6e to
a6744b0
Compare
docs/setup.md
Outdated
| - To install these dependencies run the following commands - | ||
| ```bash | ||
| brew install libpq && brew install openssl && brew install libiconv # Add libpq to the path | ||
| - Instalstdlib-jdk7l diesel_cli |
There was a problem hiding this comment.
@Subhash703 - the formatting of the commands seem a little off in the doc.
https://github.com/juspay/superposition/blob/fix/setup-instruction/docs/setup.md
Can we keep all the shell commands listed out separately without indenting them with anything. The jagged grey highlight boxes on the finally rendered doc looks a little odd.
There was a problem hiding this comment.
@knutties Could you please check again. Have modified it.
Subhash703
force-pushed
the
fix/setup-instruction
branch
5 times, most recently
from
9db18eb to
8ce4ca4
Compare
docs/setup.md
Outdated
| Don't forget to add libpq to `PATH`. | ||
| ```bash | ||
| xcode-select --install | ||
| export PATH="/usr/local/opt/libpq/bin:$PATH" |
There was a problem hiding this comment.
For ensuring libpq is picked up by diesel and/or diesel_cli, it's sufficient to set the PQ_LIB_DIR environment variable, setting PATH is not necessary:
export PQ_LIB_DIR="$(brew --prefix libpq)/lib"Also, would suggest using brew prefix instead of using /usr/local so that the path generated handles architecture differences (Intel vs Apple Silicon).
Subhash703
force-pushed
the
fix/setup-instruction
branch
from
8ce4ca4 to
7756b8b
Compare
|
@Subhash703 can you rebase this pr |
Subhash703
force-pushed
the
fix/setup-instruction
branch
from
7756b8b to
e2c6e69
Compare
There was a problem hiding this comment.
@Subhash703 - I think we can delete this line as well in the environment variable list as we have removed the corresponding sed usage.
@ShubhranshuSanjeev @Datron - please confirm. We can then merge I guess.
Problem
I faced some problems while setting up the project in my Mac OS.
Solution
Have added instructions which I followed to make it work
Environment variable changes
Added extra instruction to update .env file
Pre-deployment activity
Things needed to be done before deploying this change (if any)
Post-deployment activity
Things needed to be done after deploying this change (if any)
API changes
Possible Issues in the future
More instructions can be added in future if needed.