mirror of
https://github.com/LukeHagar/firecamp.git
synced 2025-12-06 04:19:43 +00:00
doc: readme upgraded
This commit is contained in:
120
README.md
120
README.md
@@ -1,23 +1,29 @@
|
|||||||
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|

|
||||||
|
[](https://twitter.com/intent/tweet?text=Firecamp%20-%20Open%20Source%20Postman%20alternative%20-%20Get%20instant%20API%20playgrounds%20to%20test%20Rest,%20GraphQL,%20WebSocket%20and%20SocketIO%20APIs%20.&url=https://firecamp.dev&hashtags=firecamp&via=firecamp_dev)
|
||||||
[](https://discord.gg/8hRaqhK)
|
[](https://discord.gg/8hRaqhK)
|
||||||
[](https://twitter.com/firecampdev)
|
|
||||||
|
|
||||||
# Firecamp
|
# 🔥 Firecamp
|
||||||
dx-first api devtool
|
dx-first api devtool
|
||||||
|
|
||||||
Firecamp is a dx-first API development platform that helps developers design, develop, test, and document their APIs effortlessly. With a user-friendly interface and a range of powerful features, it streamlines the API development workflow and enhances collaboration among team members.
|
Firecamp is a dx-first API development platform that helps developers design, develop, test, and document their APIs effortlessly. With a user-friendly interface and a range of powerful features, it streamlines the API development workflow and enhances collaboration among team members.
|
||||||
|
|
||||||
➠ best-in-class developer experience inspired by vscode dx. <br/>
|
- 🌈 best-in-class developer experience inspired by vscode dx. <br/>
|
||||||
➠ multi-protocol testing capabilities with Rest, GraphQL, Websocket, and SocketIO APIs. <br/>
|
- 📡 multi-protocol testing capabilities with Rest, GraphQL, Websocket, and SocketIO APIs. <br/>
|
||||||
➠ collaborate on api collections across the workspace and team <br/>
|
- 👐 collaborate on api collections across the workspace and team <br/>
|
||||||
➠ build apis faster without switching between tools and apps. documentation, cli, ci/cd under one roof <br/>
|
- ⛺ build apis faster without switching between tools and apps. documentation, cli, ci/cd under one roof <br/>
|
||||||
|
|
||||||
live at https://firecamp.dev
|
|
||||||
|
|
||||||
----
|
👉 live at https://firecamp.dev
|
||||||
|
|
||||||
### Getting started with Firecamp
|

|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 🚀 Getting started with Firecamp
|
||||||
To get started with Firecamp, follow these steps:
|
To get started with Firecamp, follow these steps:
|
||||||
|
|
||||||
1. Sign in to Firecamp at https://firecamp.dev
|
1. Sign in to Firecamp at https://firecamp.dev
|
||||||
@@ -27,40 +33,71 @@ To get started with Firecamp, follow these steps:
|
|||||||
Read the Firecamp doc for in-depth walk-throughs on functionality to understand the various features and capabilities of Firecamp.
|
Read the Firecamp doc for in-depth walk-throughs on functionality to understand the various features and capabilities of Firecamp.
|
||||||
|
|
||||||
|
|
||||||
### What Firecamp Offers?
|
### 🔬 Features
|
||||||
|
|
||||||
Firecamp offers you a broad range of features that will help you build APIs faster than ever.
|
Firecamp offers you a broad range of features that will help you build APIs faster than ever.
|
||||||
|
|
||||||
| | <div style="width:290px">Roadmap</div> | Status |
|
📂 [Collection](https://firecamp.io/docs/platform/collection) :
|
||||||
| :---: | :--- | :--- |
|
Manage Collection of APIs to collaborate within team <br/>
|
||||||
| :white_check_mark: | [**1. API Collection**](https://firecamp.io/docs/platform/collection) <br/> Manage Collection of APIs to collaborate within team | `completed` |
|
|
||||||
| :white_check_mark: | [**2. API Playgrounds**](https://firecamp.io/docs/rest/introduction) <br/> Get instant playgrounds for your APIs. Rest, GraphQL, and more. | `completed` |
|
⛳ [API Playgrounds](https://firecamp.io/docs/rest/introduction) :
|
||||||
| :white_check_mark: | [**3. API Collaboration**](https://firecamp.io/docs/collaboration/getting-started) <br/> Collaborate with your team at a centralized shared workspace. | `completed` |
|
Get instant playgrounds for your APIs. Rest, GraphQL, and more <br/>
|
||||||
| :white_check_mark: | [**4. API Authentication**](https://firecamp.io/docs/platform/authentication) <br/> Test and Debug your auth endpoints with a range of supported auths | `completed` |
|
|
||||||
| :white_check_mark: | [**5. API Scripts**](https://firecamp.io/docs/platform/scripts) <br/> Interpret the API with pre-request and tests scripts | `completed` |
|
♻️ [Team Collaboration](https://firecamp.io/docs/collaboration/getting-started) :
|
||||||
| :white_check_mark: | [**6. Dynamic Variables**](https://firecamp.io/docs/platform/environment) <br/> Set values in variables to reuse in whole platform dynamically | `completed` |
|
Collaborate with your team at a centralized shared workspace <br/>
|
||||||
| :white_check_mark: | [**7. API Workspaces**](https://firecamp.io/docs/collaboration/creating-workspace) <br/> Create multiple workspaces for better team collaboration | `completed` |
|
|
||||||
| :white_check_mark: | [**8. CLI & CI/CD**](https://firecamp.io/docs/cli/getting-started) <br/> Run API Collection Tests in the terminal or set in CI/CD pipeline | `preview` |
|
🔐 [Authentication](https://firecamp.io/docs/platform/authentication) :
|
||||||
| :white_check_mark: | [**9. Firecamp Web**](https://firecamp.dev) <br/> Get quick access to web platform | `completed` |
|
Test and Debug your auth endpoints with a range of supported auths <br/>
|
||||||
| :runner: | **10. Desktop Apps** <br/> Get the Desktop app for your preferred OS/platform | `in-progress` |
|
|
||||||
| :runner: | **11. API Test Runner** <br/> Run the API Collection visually within the platform | `in-progress` |
|
📠 [Scripts](https://firecamp.io/docs/platform/scripts) :
|
||||||
| :runner: | **12. API Documentation** <br/> Publish beautiful API documentation for your team and community | `in-progress` |
|
Interpret the API with pre-request and tests scripts <br/>
|
||||||
| :dart: | **13. SSL** <br/> Use custom SSL certificates to test out the SSL-secured API endpoints | `planned` |
|
|
||||||
| :dart: | **14. Proxy** <br/> Setup proxy while running requests from Firecamp | `planned` |
|
🔩 [Dynamic Variables](https://firecamp.io/docs/platform/environment) :
|
||||||
| :dart: | **15. Artificial Intelligence** <br/> Cutting-edge AI-powered capabilities | `planned` |
|
Set values in variables to reuse in whole platform dynamically <br/>
|
||||||
| :dart: | **16. History** <br/> Seamless history tracking | `planned` |
|
|
||||||
|
🔁 [CLI & CI/CD](https://firecamp.io/docs/cli/getting-started) :
|
||||||
|
Run API Collection Tests in the terminal or set in CI/CD pipeline <br/>
|
||||||
|
|
||||||
|
📡 [Firecamp Web](https://firecamp.dev) :
|
||||||
|
Get quick access to web platform <br/>
|
||||||
|
|
||||||
|
💻 Desktop Apps : Get the Desktop app for your preferred OS/platform <br/>
|
||||||
|
|
||||||
|
➿ API Test Runner : Run the API Collection visually within the platform </br>
|
||||||
|
|
||||||
|
📄 API Documentation : Publish beautiful API documentation for your team and community </br>
|
||||||
|
|
||||||
|
⚓ SSL : Use custom SSL certificates to test out the SSL-secured API endpoints </br>
|
||||||
|
|
||||||
|
📝 Proxy : Setup proxy while running requests from Firecamp </br>
|
||||||
|
|
||||||
|
☑️ Artificial Intelligence : Cutting-edge AI-powered capabilities </br>
|
||||||
|
|
||||||
|
ℹ️ History : Seamless history tracking
|
||||||
|
|
||||||
|
|
||||||
### API Playgrounds
|
### API Playgrounds
|
||||||
There is a dedicated GUI playground for each API protocol you would be using for your stack.
|
There is a dedicated GUI playground for each API protocol you would be using for your stack.
|
||||||
|
|
||||||
| | |
|
1. [**Rest Playground**](https://firecamp.io/docs/rest/introduction)
|
||||||
| :--- | :--- |
|
It's the lightweight, IntelliSense, and next-generation testing client to give the most delightful collaborative experience while building APIs in a team.
|
||||||
| :white_check_mark: | [**1. Rest Playground**](https://firecamp.io/docs/rest/introduction) <br/> It's the lightweight, IntelliSense, and next-generation testing client to give the most delightful collaborative experience while building APIs in a team. |
|
|
||||||
| :white_check_mark: | [**2. GraphQL Playground**](https://firecamp.io/docs/graphql/introduction) <br/> Perform GraphQL operations with a seamless experience. Prepare, Share, and | :white_check_mark: | Export your Query Collection collaboratively with your team.|
|
|
||||||
| :white_check_mark: | [**3. WebSocket Playground**](https://firecamp.io/docs/websocket/introduction) <br/> Debug bidirectional connection visually with WebSocket GUI client more precisely now. The only GUI client to test, debug, and visualize real-time or event-driven messages collaboratively. |
|
|
||||||
| :white_check_mark: | [**4. Socket.io Playground**](https://firecamp.io/docs/socket-io/introduction) <br/> Monitor each emitter’s and listener’s events visually over a bi-directional SocketIO connection. It enables you to collaborate with the team over a SocketIO event-driven API build.| |
|
|
||||||
| 🎯 | **5. What's next?** <br/> → please [let us know](https://github.com/firecamp-dev/Firecamp/issues/new?assignees=&labels=&projects=&template=general_report.md&title=) |
|
|
||||||
|
|
||||||
### Community and Support
|
2. [**GraphQL Playground**](https://firecamp.io/docs/graphql/introduction)
|
||||||
|
Perform GraphQL operations with a seamless experience. Prepare, Share, and Export your Query Collection collaboratively with your team.
|
||||||
|
|
||||||
|
3. [**WebSocket Playground**](https://firecamp.io/docs/websocket/introduction)
|
||||||
|
Debug bidirectional connection visually with WebSocket GUI client more precisely now. The only GUI client to test, debug, and visualize real-time or event-driven messages collaboratively.
|
||||||
|
|
||||||
|
4. [**Socket.io Playground**](https://firecamp.io/docs/socket-io/introduction)
|
||||||
|
Monitor each emitter’s and listener’s events visually over a bi-directional SocketIO connection. It enables you to collaborate with the team over a SocketIO event-driven API build.
|
||||||
|
|
||||||
|
5. **What's next?** <br/> → please [let us know](https://github.com/firecamp-dev/Firecamp/issues/new?assignees=&labels=&projects=&template=general_report.md&title=)
|
||||||
|
|
||||||
|
### Get Involved
|
||||||
|
|
||||||
|
Here is the [guide for contributions](https://github.com/firecamp-dev/firecamp/blob/main/CONTRIBUTING.md) to help you begin your journey in contributing.
|
||||||
|
|
||||||
|
### 🏆 Community and Support
|
||||||
|
|
||||||
For community support, you can join the Firecamp community on [Discord](https://discord.gg/8hRaqhK). You can also check out the [Firecamp Blog](https://firecamp.io/blog) for the latest updates, tutorials, and articles.
|
For community support, you can join the Firecamp community on [Discord](https://discord.gg/8hRaqhK). You can also check out the [Firecamp Blog](https://firecamp.io/blog) for the latest updates, tutorials, and articles.
|
||||||
|
|
||||||
@@ -71,23 +108,18 @@ Here are helpful links for Firecamp
|
|||||||
|
|
||||||
If you encounter any bugs, or issues, or have suggestions, please open an issue on the [Firecamp GitHub repository](https://github.com/firecamp-dev/Firecamp). We appreciate your contributions to making Firecamp even better.
|
If you encounter any bugs, or issues, or have suggestions, please open an issue on the [Firecamp GitHub repository](https://github.com/firecamp-dev/Firecamp). We appreciate your contributions to making Firecamp even better.
|
||||||
|
|
||||||
### Philosophy
|
### 💭 Philosophy
|
||||||
The decentralization of tools, processes, and people creates friction in API development workflow and frustration across the team. Developers are constantly switching between tools, searching for information, and wasting time due to inefficient tools.
|
The decentralization of tools, processes, and people creates friction in API development workflow and frustration across the team. Developers are constantly switching between tools, searching for information, and wasting time due to inefficient tools.
|
||||||
We believe that the existing solution lacks both world-class experience and the simplicity needed to build APIs faster. This leads to a decrease in developer productivity, slow release times, and poor team collaboration.
|
We believe that the existing solution lacks both world-class experience and the simplicity needed to build APIs faster. This leads to a decrease in developer productivity, slow release times, and poor team collaboration.
|
||||||
We are bringing the VS code philosophy to Firecamp to solve this critical problem. Our mission is to build the most extensible, minimal and best developer experience API platform where developers feel most productive while building APIs.
|
We are bringing the VS code philosophy to Firecamp to solve this critical problem. Our mission is to build the most extensible, minimal and best developer experience API platform where developers feel most productive while building APIs.
|
||||||
|
|
||||||
### What's cool about this?
|
### 🏄 What's cool about this?
|
||||||
|
|
||||||
Firecamp is a Multi-protocol API platform, which offers end-to-end testing and development of Rest, GraphQL, WebSocket, and many other APIs.
|
Firecamp is a Multi-protocol API platform, which offers end-to-end testing and development of Rest, GraphQL, WebSocket, and many other APIs.
|
||||||
We support major API specifications and protocols, which allows for seamless API testing, API documentation, and smoother collaboration between backend, frontend, and mobile teams.
|
We support major API specifications and protocols, which allows for seamless API testing, API documentation, and smoother collaboration between backend, frontend, and mobile teams.
|
||||||
|
|
||||||
### Internet Mentions
|
|
||||||
1. https://dev.to/firecampdev/lightweight-postman-alternative-introducing-firecamp-3066
|
|
||||||
2. https://www.asyncapi.com/blog/socketio-automatic-docs
|
|
||||||
3. https://twitter.com/Nishchit14/status/1679523569091633153
|
|
||||||
|
|
||||||
|
|
||||||
### Contributors
|
### 💎 Contributors
|
||||||
|
|
||||||
<a href="https://github.com/firecamp-dev/firecamp/graphs/contributors">
|
<a href="https://github.com/firecamp-dev/firecamp/graphs/contributors">
|
||||||
<img src="https://contrib.rocks/image?repo=firecamp-dev/firecamp" />
|
<img src="https://contrib.rocks/image?repo=firecamp-dev/firecamp" />
|
||||||
|
|||||||
@@ -15,6 +15,8 @@ Firecamp is a dx-first API development platform that helps developers design, de
|
|||||||
|
|
||||||
live at https://firecamp.dev
|
live at https://firecamp.dev
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
||||||
### Getting started with Firecamp
|
### Getting started with Firecamp
|
||||||
|
|||||||
Reference in New Issue
Block a user