Skip to content

Commit 2e447f1

Browse files
committed
Update README.md
1 parent d4a01e8 commit 2e447f1

File tree

1 file changed

+53
-2
lines changed

1 file changed

+53
-2
lines changed

README.md

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,56 @@
11
# Places
22

3-
Manage addresses and show them on a map.
3+
Manage places and show them on a map.
44

5-
This module is part of [TypiCMS](https://github.com/TypiCMS/Base), a multilingual CMS based on the [Laravel framework](https://github.com/laravel/framework).
5+
## Installation
6+
7+
1. Require the package using composer:
8+
9+
```bash
10+
composer require typicms/places
11+
```
12+
13+
2. Add the service provider in your config/app.php file:
14+
15+
```
16+
'providers' => [
17+
/*
18+
* TypiCMS Modules Service Providers.
19+
*/
20+
TypiCMS\Modules\Places\Providers\ModuleProvider::class,
21+
];
22+
```
23+
24+
3. Publish files from this module to your project, run:
25+
26+
```bash
27+
php artisan vendor:publish --provider="TypiCMS\Modules\Places\Providers\ModuleServiceProvider"
28+
```
29+
30+
4. Set a Google Maps API key in your .env file.
31+
See [Google Maps Platform](https://developers.google.com/maps/documentation/javascript/get-api-key).
32+
33+
5. Install @googlemaps/markerclusterer:
34+
35+
```bash
36+
yarn add @googlemaps/markerclusterer --dev
37+
```
38+
39+
6. Uncomment the following lines in `/resources/js/public.js`:
40+
41+
```js
42+
import initMap from './public/map';
43+
44+
window.initMap = initMap;
45+
```
46+
47+
7. Import the scss file in `/resources/scss/public.scss`:
48+
49+
```scss
50+
@import 'public/map';
51+
```
52+
53+
8. Run `yarn dev` to compile the assets.
54+
55+
This module is part of [TypiCMS](https://github.com/TypiCMS/Base), a multilingual CMS based on
56+
the [Laravel framework](https://github.com/laravel/framework).

0 commit comments

Comments
 (0)