Skip to content

Commit ac526e1

Browse files
authored
Update documentation for frontend setup (#695)
1 parent bea2a15 commit ac526e1

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Contributing
1616

1717
[issue-list]: https://github.com/pythonindia/junction/issues/
1818
[new-issue]: https://github.com/pythonindia/junction/issues/new
19-
[guidelines]: https://github.com/pythonindia/junction/blob/master/.github/CONTRIBUTING.md
19+
[guidelines]: .github/CONTRIBUTING.rst
2020
[getting-started]: https://in-junction.readthedocs.io/en/latest/development/getting-started.html
2121

2222
License

docs/source/development/getting-started.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,14 @@ created with the username ``admin`` and password ``123123``.
5858
Frontend
5959
--------
6060

61-
Working on Junction's frontend requires `NodeJS`_ to be installed on your
62-
system. The frontend is built using `bower`_ and `grunt`_. To setup the working
61+
Working on Junction's frontend requires `NodeJS`_ and `yarn`_ to be installed on your
62+
system. The frontend is built using `grunt`_. To setup the working
6363
environment, run the following:
6464

6565
.. code-block:: console
6666
6767
$ cd junction/static
68-
$ npm install
69-
$ bower install
68+
$ yarn install
7069
7170
Development workflow
7271
====================
@@ -82,6 +81,10 @@ every file change.
8281
8382
$ grunt
8483
84+
For ease of development ``app.css`` is checked in to the source code. It is not
85+
recommended to directly make changes to ``app.css``, rather update the less files
86+
and run ``grunt``, then commit ``app.css``
87+
8588
Invoking ``manage.py``
8689
----------------------
8790

@@ -126,5 +129,5 @@ For building the documentation, run:
126129
.. _`virtualenv`: https://virtualenv.pypa.io/en/stable/
127130
.. _`nox`: https://nox.readthedocs.io/en/stable/
128131
.. _`NodeJS`: https://nodejs.org/
129-
.. _`bower`: https://bower.io/
132+
.. _`yarn`: https://yarnpkg.com/
130133
.. _`grunt`: https://gruntjs.com/

0 commit comments

Comments
 (0)