Updated ReadMe with solutions to installation problems and creating an admin user (#1339)

* Updated ReadMe with solution to installation problem that may occur

* Updated Developer Documentation with instructions for creating an Admin User
This commit is contained in:
Shivam Agarwal 2021-05-29 03:30:52 +05:30 коммит произвёл GitHub
Родитель 4047210ebc
Коммит 072e92d4b2
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
2 изменённых файлов: 16 добавлений и 1 удалений

Просмотреть файл

@ -18,6 +18,8 @@ Chrome Platform Status
1. Install npm dependencies `npm ci`
1. Install other dependencies `npm run deps` and `npm run dev-deps`
If you face any error during the installation process, the section **Notes** (later in this README.md) may help.
##### Add env_vars.yaml
Create a file named `env_vars.yaml` in the root directory and fill it with:
@ -62,7 +64,7 @@ There are some developing information in developer-documentation.md.
**Notes**
- If you get an error saying `No module named protobuf`, try installing it locally with `python -m pip install protobuf`.
- If you get an error saying `No module named protobuf` or `No module named six` or `No module named enum` , try installing them locally with `pip install six enum34 protobuf`.
- When installing the GAE SDK, make sure to get the version for python 2.7. It is no longer the default version.

Просмотреть файл

@ -27,6 +27,19 @@ All the pages are rendered in a combination of Django template (`/templates`) an
1. All JavaScript files are in `/static/js-src/` and processed by gulp, then output to '/static/js/' and get included in templates.
1. All CSS files are in `/static/sass/` and processed by gulp, then output to `/static/css/` and get included in templates.
## Creating a user with admin privileges
To create or edit features, you must log in using an email which has admin privileges. An email has admin privileges if it is stored in the Datastore with `is_admin` property set to `True`. To create an admin user for your local installation follow these steps:-
1. Access Admin Server using the url mentioned in the command line output of `npm start`.
1. Click on interactive console and execute the following query:-
```
from internals import models
appuser_1 = models.AppUser(email='your_account@domain_name.tld', is_admin=True)
appuser_1.put()
```
To view and edit the users datastore, you can click on Datastore Viewer. Make sure that `Entity Kind` is set to `AppUser`.
## Some nice-to-fix
- Wrap page in a component, so the data flow is more clear. Benefits: no need to assigns component properties from js files; no need to pass element reference to components to get value (e.g. we are passing searchEl to chromedash-featurelist.).