Skip to content

docs(backend): basic api example #1

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

Draft
thenav56 wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs(backend): basic api example #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b72acb3
docs(backend): basic api example
thenav56 Oct 29, 2025
73e096b
docs(backend): include draft project creation and file upload examples
thenav56 Nov 5, 2025
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
1 change: 1 addition & 0 deletions examples/mapswipe-backend-api/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.env
13 changes: 13 additions & 0 deletions examples/mapswipe-backend-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

> [!CAUTION]
> This script provides a simple way to interact with the MapSwipe backend endpoint.\
> Future updates may introduce breaking changes.


Copy `sample.env` as `.env` and change the required variables

Run the example script using uv
```
uv run run.py
```
> NOTE: To install uv https://docs.astral.sh/uv/getting-started/installation/
Loading