Skip to content

Commit

Permalink
update README with header modification docs
Browse files Browse the repository at this point in the history
  • Loading branch information
skykanin committed Jun 18, 2024
1 parent 227457e commit 9e997b3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 19 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,6 @@
</p>
</div>

<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
</li>
<li><a href="#developing">Developing</a></li>
<li>
<a href="#setup">Setup</a>
<ul>
<li><a href="#tips">Tips</a></li>
<li><a href="#eslint-and-prettier">ESLint and Prettier</a></li>
<li><a href="#ide-support">IDE Support</a></li>
</ul>
</li>
</ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project
Expand Down Expand Up @@ -66,6 +47,12 @@ powerful primitives for managing asynchrounous effects in a sane way with strong
npm run dev
```

### Note about local development

Dapla Ctrl assumes all requests include an authorization header when sending requests to the API. Therefore, when developing locally you will need to have a browser plugin that modifies the header with your bearer token. For example you can use [header editor](https://addons.mozilla.org/en-US/firefox/addon/header-editor) for firefox. Add a new rule which matches the URL for the development server and add an authorization header with `Bearer <token>`, don't forget the space between "Bearer" and the token.

![Screenshot showing how to modify request headers in a browser extension](<docs/images/modify_header.png>)

### Tips

You can use [direnv](https://github.com/direnv/direnv) to automatically hook into your nix shell environment
Expand Down
Binary file added docs/images/modify_header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9e997b3

Please sign in to comment.