Skip to content

docs: Show the api option in the quick start guide #8827

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
+7 −1
Closed

docs: Show the api option in the quick start guide #8827

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 @@ -86,13 +86,19 @@ Then paste your API key into the code below:
<script>
flagsmith.init({
environmentID: '<add your API key here!>',
// Only needed if you are self-hosting Flagsmith or using a private cloud instance.
// Leave this out to use Flagsmith SaaS (edge.api.flagsmith.com).
// api: 'https://flagsmith.example.com/api/v1/',
onChange: (oldFlags, params) => {},
});
</script>
```

If you are self-hosting Flagsmith or using a private cloud instance, uncomment the `api` line and set it to your
Flagsmith API URL, including the `/api/v1/` path.

Now when the browser opens the web page, it will download the Javascript SDK and make a call to `edge.api.flagsmith.com`
to get the flags for our Environment. You can see this in the browser network tab:
(or your own API URL) to get the flags for our Environment. You can see this in the browser network tab:

<div style={{textAlign: 'center'}}><img width="75%" src="/img/quickstart/demo_create_7.png"/></div>

Expand Down
Loading