Skip to content

docs(Quickstart): The flagsmith.init command in the quickstart guide should include the api argument #8823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
emyller wants to merge 1 commit into from
Closed

docs(Quickstart): The flagsmith.init command in the quickstart guide should include the api argument #8823

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/docs/getting-started/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,14 @@ We can now connect to the Flagsmith API and get our Flags. When you initialise t

![SDK Keys](/img/quickstart/demo_create_6.png)

Then paste your API key into the code below:
Then paste your API key into the code below. If you are self-hosting Flagsmith or using a private cloud instance, also uncomment the `api` option and set it to the URL of your Flagsmith API. You can leave it out if you are using Flagsmith SaaS.

```html
<script>
flagsmith.init({
environmentID: '<add your API key here!>',
// Self-hosted or private cloud only: point the SDK at your own Flagsmith API
// api: 'https://flagsmith.example.com/api/v1/',
onChange: (oldFlags, params) => {},
});
</script>
Expand All @@ -106,6 +108,8 @@ Let's hook this value up to our button, so that the value of the flag controls w
<script>
flagsmith.init({
environmentID: '<add your API key here!>',
// Self-hosted or private cloud only: point the SDK at your own Flagsmith API
// api: 'https://flagsmith.example.com/api/v1/',
onChange: (oldFlags, params) => {
if (flagsmith.hasFeature('show_demo_button')) {
var submit_button = document.getElementById('submit_button');
Expand All @@ -131,6 +135,8 @@ Our entire web page now reads like this:
<script>
flagsmith.init({
environmentID: 'ZfmJTbLQZrhZVHkVhXbsNi',
// Self-hosted or private cloud only: point the SDK at your own Flagsmith API
// api: 'https://flagsmith.example.com/api/v1/',
onChange: (oldFlags, params) => {
if (flagsmith.hasFeature('show_demo_button')) {
var submit_button = document.getElementById('submit_button');
Expand Down
Loading