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

added setup instructions for local system using docker. #804

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,27 @@ Contributing
[guidelines]: .github/CONTRIBUTING.rst
[getting-started]: https://in-junction.readthedocs.io/en/latest/development/getting-started.html



<p><strong>To setup this on your local system. Follow the steps: </strong></p>
<p>To start with you have to setup docker on your local system. For that you need docker-compose to be installed on your system.</p>
<code>brew install docker-compose</code> for mac<br>
<code>sudo apt install docker-compose</code> for linux<br>

Check the path of the docker-compose using<br><code>echo $PATH</code>
If <code>/usr/local/bin</code> is not in your path, you need to add it.<br><pre><code>echo 'export PATH="$PATH:/usr/local/bin"' >> ~/.zshrc
source ~/.zshrc</code></pre>
<p>After accomplishing these steps you need to login into your docker account</p>
<code>docker login</code><br>If you are using the cli version you need to execute <code>docker login username <__username__></code><p>After successfully following these steps you can refer to the docs[getting-started] for further execution of the application</p>
License
-------

This software is licensed under The MIT License(MIT). See the [LICENSE][LICENSE] file in the top distribution directory for the full license text.

[LICENSE]: https://github.com/pythonindia/junction/blob/master/LICENSE