https://github.com/EsperoTech/yaade Skip to content Sign up * Product + Features + Mobile + Actions + Codespaces + Packages + Security + Code review + Issues + Integrations + GitHub Sponsors + Customer stories * Team * Enterprise * Explore + Explore GitHub + Learn and contribute + Topics + Collections + Trending + Learning Lab + Open source guides + Connect with others + The ReadME Project + Events + Community forum + GitHub Education + GitHub Stars program * Marketplace * Pricing + Plans + Compare plans + Contact Sales + Education [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} EsperoTech / yaade Public * Notifications * Fork 2 * Star 249 Yaade is an open-source, self-hosted, collaborative API development environment. MIT License 249 stars 2 forks Star Notifications * Code * Issues 1 * Pull requests 0 * Actions * Projects 0 * Wiki * Security * Insights More * Code * Issues * Pull requests * Actions * Projects * Wiki * Security * Insights This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 1 branch 0 tags Code Latest commit Jonathan Roesner add openapi to readme ... 2c8af76 Apr 3, 2022 add openapi to readme 2c8af76 Git stats * 42 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time assets add screenshots Mar 24, 2022 client fix bugs Apr 2, 2022 dev-proxy small refinements Mar 18, 2022 extension working auto save features Mar 30, 2022 node_modules refactor most of the state handling Mar 29, 2022 scripts add a script to execute when developing only the client Apr 1, 2022 server feature: import OpenAPI Mar 30, 2022 LICENSE Working docker image and MIT license Mar 15, 2022 README.md add openapi to readme Apr 3, 2022 package-lock.json refactor most of the state handling Mar 29, 2022 package.json refactor most of the state handling Mar 29, 2022 View code [ ] Yaade - Yet Another API Development Environment Why did you develop Yaade? Features [?] Install 1. Docker 2. Extension Technology [?] Local development Build Screenshots Dark mode [?] Light mode How can I contribute? README.md yaade-icon Yaade - Yet Another API Development Environment Yaade is an open-source, self-hosted, collaborative API development environment. dark-mode-screenshot Why did you develop Yaade? I was looking for a self-hosted Postman alternative so that API collections can easily be shared between teammates. Even though popular solutions like Hoppscotch exist, their self-hosted app does not come with authentication and relies on Firebase for persistency. Yaade is developed from the ground up with self-hosting and security in mind. That means sensitive information in API requests can safely be stored on your own server! Features 1. Self-hosted: data never leaves your own server 2. Secured: if you don't know the password, you can't get in 3. Persistent: even across container or server restarts 4. Import your OpenAPI v3 files 5. Easy single-file data import / export 6. Requests are executed on your machine so you can call localhost as well as remote servers 7. Most importantly: dark mode default [?] Install To have the best experience with Yaade run the docker container on your server and install the browser extension on your local machine. 1. Docker $ docker volume create yaade $ docker run -d --restart=always -p 9339:9339 -e YAADE_ADMIN_USERNAME=admin -v yaade:/app/data --name yaade esperotech/yaade:latest The default password is password. After login go to [?][?] > Account and change the password. 2. Extension Yaade uses a browser extension as a proxy to enable CORS requests. Install the extension using your browsers extension store. Currently only a chrome extension is available. You can find it here. Then open it and input your server URL, eg. https://yaade.example.com/. From that point all requests originating from your Yaade browser tabs will be proxied through the extension. [?][?] DO NO FORGET TO ADD A TRAILING SLASH TO YOUR URL https:// yaade.example.com -> https://yaade.example.com/. Technology 1. SPA built with TypeScript, React and Vite. 2. Backend built with Kotlin. 3. H2 file-based database. 4. Browser extension with plain JavaScript. [?] Local development 1. Install the required dependencies + Java 11 + Kotlin + Node >= 16 2. Clone the repository 3. Install the project specific dependencies $ cd scripts/ $ chmod +x install.sh $ ./install.sh 4. Start the server on port 9339 using your IDE of choice (I use IntelliJ IDEA) + you can also run it by using the jar file directly $ java -jar server/build/libs/yaade-server-1.0-SNAPSHOT + note that you must set the environment variable YAADE_ADMIN_USERNAME to run 5. Start the vite dev server on port 9338 $ cd client/ $ npm run dev 6. Start the dev-proxy on port 9337 $ cd dev-proxy/ $ node index.js 7. Now open your browser and visit http://localhost:9337 Build $ cd scripts/ $ chmod +x build.sh $ ./build.sh Screenshots Dark mode dark-mode-screenshot [?] Light mode light-mode-screenshot How can I contribute? Your contribution is very welcome! First open an issue about the topic you want to contribute on, eg. adding a new feature, bugfixing or refactoring. We will then discuss further details. Eventually, I will review your Pull Request and merge / release it. About Yaade is an open-source, self-hosted, collaborative API development environment. Topics kotlin api docker typescript selfhosted postman h2-database hoppscotch Resources Readme License MIT License Stars 249 stars Watchers 4 watching Forks 2 forks Releases No releases published Packages 0 No packages published Languages * TypeScript 61.7% * Kotlin 24.6% * CSS 9.1% * JavaScript 3.4% * HTML 0.6% * Shell 0.5% * Dockerfile 0.1% * (c) 2022 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.