LukeParke/firecamp
1
0
Fork 0
mirror of https://github.com/LukeHagar/firecamp.git synced 2025-12-06 12:27:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.v2.md

Browse Source
This commit is contained in:
Shreya Ranpariya
2023-08-31 17:27:41 +05:30
committed by GitHub
parent b5eb24e9c6
commit 8a4f45403f
1 changed files with 45 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
readme/README.v2.md
View File

@@ -1,13 +1,25 @@
<p align="center">
<a href="https://firecamp.dev">
<img src="https://github.com/firecamp-dev/firecamp/blob/main/.github/logo.svg" alt="Firecamp Logo" width="70">
</a>
</p>
<h3 align="center"><b>Firecamp</b></h3>
<p align="center"><b>dx-first open-source api devtool</b></p>
![FirecampCoverImage](.github/github-cover.png) <p align="center">
<a href="https://discord.gg/8hRaqhK">
<img alt="Discord online members" src="https://badgen.net/discord/members/8hRaqhK?color=5865F2&label=Discord&style=for-the-badge" />
</a>
</p>
![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github) <p align="center">
[![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Ffirecamp.io%2F)](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) <a href="https://firecamp.dev">
[![Firecamp Discord](https://badgen.net/discord/members/8hRaqhK)](https://discord.gg/8hRaqhK) <img alt ="firecamp-cover" src="https://github.com/firecamp-dev/firecamp/assets/5078921/1ef25fd3-bf97-4bd0-b440-7c1f4ef3eb22"/>
</a>
</p>
# 🔥 Firecamp # 🔥 Firecamp
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.
@@ -19,11 +31,8 @@ Firecamp is a dx-first API development platform that helps developers design, de
👉 live at https://firecamp.dev 👉 live at https://firecamp.dev
![alt text](https://user-images.githubusercontent.com/5078921/262089548-1ef25fd3-bf97-4bd0-b440-7c1f4ef3eb22.png)
## 🚀 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
@@ -33,7 +42,7 @@ 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.
### 🔬 Features ## 🔬 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.
@@ -55,28 +64,11 @@ Interpret the API with pre-request and tests scripts <br/>
🔩 [Dynamic Variables](https://firecamp.io/docs/platform/environment) : 🔩 [Dynamic Variables](https://firecamp.io/docs/platform/environment) :
Set values in variables to reuse in whole platform dynamically <br/> Set values in variables to reuse in whole platform dynamically <br/>
🔁 [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) : 📡 [Firecamp Web](https://firecamp.dev) :
Get quick access to web platform <br/> 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 Playgrounds
📄 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
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) 1. [**Rest Playground**](https://firecamp.io/docs/rest/introduction)
@@ -91,13 +83,32 @@ There is a dedicated GUI playground for each API protocol you would be using for
4. [**Socket.io Playground**](https://firecamp.io/docs/socket-io/introduction) 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. 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=) ## 🛣️ Roadmap
### Get Involved
💻 Desktop Apps : Get the Desktop app for your preferred OS/platform <br/>
🛰️ Self-hosted : Host Firecamp on your own server
🔁 CLI & CI/CD : Run API Collection Tests in the terminal or set in CI/CD pipeline <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>
⚛️ Artificial Intelligence : Cutting-edge AI-powered capabilities </br>
⚓ SSL : Use custom SSL certificates to test out the SSL-secured API endpoints </br>
📝 Proxy : Setup proxy while running requests from Firecamp </br>
ℹ️ History : Seamless history tracking
## 📡 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. 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 ## 🏆 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.
@@ -108,18 +119,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.
### 💎 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" />