Changes for README.md: 13 added lines, 7 removed lines.
Original line number
Diff line number
Diff line
@@ -9,26 +9,31 @@ Our goal is to make it easier to find and install modules for people new to Drup
- For the description of the module visit: [https://www.drupal.org/project/project_browser](https://www.drupal.org/project/project_browser)
- To submit bug reports and feature suggestions or to track changes, visit: [https://www.drupal.org/project/issues/project_browser?categories=All](https://www.drupal.org/project/issues/project_browser?categories=All)
## Requirements
------------
This module requires no modules outside of Drupal core.
## Installation
------------
*If you intend to contribute to Project Browser, skip this step and use the "Contributing" instructions instead*
*If you intend to contribute to Project Browser, skip this step and use the "Contributing" instructions instead*
Install with composer: `composer require drupal/project_browser` then enable the module.
# Contributing
## Contributing
- Follow the [Git instructions](https://www.drupal.org/project/project_browser/git-instructions
) to clone project browser to your site.
) to clone project browser to your site
- In the `/project_browser` directory, install PHP dependencies with `composer install`
- In the `/project_browser/sveltejs` directory install JS dependencies `yarn install` and run the dev script `yarn dev` which will watch for filesystem changes
- Note: `yarn dev` will report the app is availble localhost, but it is fully available in your Drupal site at `admin/modules/browse`
- In the `/project_browser/sveltejs` directory:
- install JS dependencies with `yarn install`
- For development, run the dev script `yarn dev` which will watch for filesystem changes
- Note: `yarn dev` will report the app is available localhost, but it is fully available in your Drupal site at `admin/modules/browse`
- When you are done, compile the changes with `yarn build`
_NOTE: More information is available in the contributor.md file!_
## Configuration
@@ -38,6 +43,7 @@ Filter by Recommended projects or All projects
Search and filter by Title, Sort By, Order and Categories
