Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/outsystems/outsystems-maps
Repository with the source code for OutSystems Maps.
https://github.com/outsystems/outsystems-maps
engineering google-maps leaflet maps o11 outsystems platform-o11 snyk-o11 ssdlc-rules
Last synced: about 2 months ago
JSON representation
Repository with the source code for OutSystems Maps.
- Host: GitHub
- URL: https://github.com/outsystems/outsystems-maps
- Owner: OutSystems
- License: bsd-3-clause
- Created: 2020-10-23T09:01:44.000Z (about 4 years ago)
- Default Branch: dev
- Last Pushed: 2024-09-16T13:35:19.000Z (4 months ago)
- Last Synced: 2024-09-17T15:58:51.917Z (4 months ago)
- Topics: engineering, google-maps, leaflet, maps, o11, outsystems, platform-o11, snyk-o11, ssdlc-rules
- Language: TypeScript
- Homepage: https://www.outsystems.com/forge/component-overview/9909/outsystems-maps
- Size: 4.85 MB
- Stars: 10
- Watchers: 32
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# OutSystems Maps · v2.0.0
 
Add maps to your applications **OutSystems Reactive Web apps** with a single or multiple locations. Fully customizable and adaptable, allows you to change map behaviors, customize your map, add markers and customize each of them, according to your use case.
## About the component
Maps made easy, from developers to developers.
Use the OutSystems Maps to create visual rich enterprise-grade interfaces that help the user to quickly have map-based insights of the data.
#### Key features
* Built for Web and Mobile apps
* Simple to use and extend
* Add Markers, and Directions
* **No javascript knowledge required**
### Where can you find the component?
The OutSystems component, like all components, can be found in [OutSystems forge](https://www.outsystems.com/forge/component-overview/9909/outsystems-maps). There you can also find a [sample application](https://www.outsystems.com/forge/component-overview/10984/outsystems-maps-sample) that show-cases several uses of the component.
The documentation for the component can be found in the [official page](https://success.outsystems.com/Documentation/11/Developing_an_Application/Design_UI/Patterns/Using_Mobile_and_Reactive_Patterns/Map), as well as, in a more interactive way in the [Component living documentation](https://outsystemsui.outsystems.com/OutSystemsMapsSample/).
### Why use this component?
If you're using OutSystems, this is how you can use this component in your application:
## About this repository
This repository contains the code that enable the usage of an external provider **Google Maps** to which you're required to [obtain a license](https://developers.google.com/maps/documentation/javascript/get-api-key).
The code is written in TypeScript🖤, and you are welcome to branch it and PR your changes/proposals!
### What tools should you use?
We highly recommend the usage of the following tools:
* [Visual Studio Code](https://code.visualstudio.com/)
* With these extensions:
* Document This
* ESLint
* Prettier - Code formatter
### How to use change this code?
1. Create a branch based in the branch **master** (lastest & greatest release)
2. Open your Visual Studio Code in your branch
3. Run the following command in Visual Studio Code terminal: `npm install` (this will install all the dependencies that you need)
4. Do your magic! :)
5. **Document your code** (with the extension "Document This", start typing `/**` and the extension will give you a good starting point
6. Compile and fix errors and warnings (in Visual Studio Code terminal: `npm run build`)
7. Check if the code format is following our conventions (in Visual Studio Code terminal: `npm run lint`)
- Some of the conventions can be fixed automatically by lint (in Visual Studio Code terminal: `npm run lintfix`)
- Although the script above execute the prettier conventions, you may want to run it over all project files (in Visual Studio Code terminal: `npm run prettier`)
8. Fix all errors & warnings! :)
9. Create a PR, describing what was the (mis)behavior, what you changed and please provide a sample
### How to add new feature/fix?
* A new branch from **master** should be created.
* If possible the branch should be kept updated with the master branch.
* If possible unnecessary commit messages should be omitted.
### How to do a Pull Request?
After completing your changes, and testing, please proceed with submitting a Pull Request.
To be accepted, a Pull Request needs to:
1. **Fulfill the following requirements**
* Needs to compile without errors
* Needs to follow the code style rules (without warnings and errors)
* Needs to be approved by 2 team members (owners of the repo)
* The Pull Request template, should be filled up by the Pull Requestor:
* Provide a short description
* A link to a sample page showing the fixed behavior or the new feature
* What was happening?
* What was done?
* Tests steps
* Screenshots
* Checklist
2. **Follow best practices**
* The submitted code should be well documented (e.g. comments).
* Avoid changes outside the scope of the issue in hands.
* Avoid exposing sensible information of any kind (e.g. internal server link, process, etc).
## Useful Links
* Download latest version in [OutSystems forge](https://www.outsystems.com/forge/component-versions/9909)
* Test the latest changes in the [sample app](https://www.outsystems.com/forge/component-overview/10984/outsystems-maps-sample)
* [Component living documentation](https://outsystemsui.outsystems.com/OutSystemsMapsSample/)
* Component [documentation](https://success.outsystems.com/Documentation/11/Developing_an_Application/Design_UI/Patterns/Using_Mobile_and_Reactive_Patterns/Map)
## 📫 Have a question? Want to chat? Ran into a problem?
Write us in [the component support page](https://www.outsystems.com/forge/component-discussions/9909/OutSystems+Maps)!
## How to sign up for the announcement list
Available internally on Slack channel _#rd-uicomponents-contributors_.
## Keywords
GitHub - OutSystems - Maps