Skip to content

Commit 396c969

Browse files
authored
Merge pull request #59 from firecamp-dev/readme
Readme Changes
2 parents ca494d6 + a462e4a commit 396c969

3 files changed

Lines changed: 203 additions & 45 deletions

File tree

README.md

Lines changed: 75 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,29 @@
1+
2+
13
![FirecampCoverImage](.github/github-cover.png)
24

5+
![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)
6+
[![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)
37
[![Firecamp Discord](https://badgen.net/discord/members/8hRaqhK)](https://discord.gg/8hRaqhK)
4-
[![Twitter: Firecamp](https://img.shields.io/twitter/follow/firecampdev.svg?style=social)](https://twitter.com/firecampdev)
58

6-
# Firecamp
9+
# 🔥 Firecamp
710
dx-first api devtool
811

912
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.
1013

11-
best-in-class developer experience inspired by vscode dx. <br/>
12-
multi-protocol testing capabilities with Rest, GraphQL, Websocket, and SocketIO APIs. <br/>
13-
collaborate on api collections across the workspace and team <br/>
14-
build apis faster without switching between tools and apps. documentation, cli, ci/cd under one roof <br/>
14+
- 🌈 best-in-class developer experience inspired by vscode dx. <br/>
15+
- 📡 multi-protocol testing capabilities with Rest, GraphQL, Websocket, and SocketIO APIs. <br/>
16+
- 👐 collaborate on api collections across the workspace and team <br/>
17+
- build apis faster without switching between tools and apps. documentation, cli, ci/cd under one roof <br/>
1518

16-
live at https://firecamp.dev
1719

18-
![firecamp-cover (12)](https://github.com/firecamp-dev/firecamp/assets/5078921/1ef25fd3-bf97-4bd0-b440-7c1f4ef3eb22)
1920

20-
----
21+
👉 live at https://firecamp.dev
22+
23+
![firecamp-cover](https://github.com/firecamp-dev/firecamp/assets/5078921/1ef25fd3-bf97-4bd0-b440-7c1f4ef3eb22)
2124

22-
### Getting started with Firecamp
25+
26+
### 🚀 Getting started with Firecamp
2327
To get started with Firecamp, follow these steps:
2428

2529
1. Sign in to Firecamp at https://firecamp.dev
@@ -29,40 +33,71 @@ To get started with Firecamp, follow these steps:
2933
Read the Firecamp doc for in-depth walk-throughs on functionality to understand the various features and capabilities of Firecamp.
3034

3135

32-
### What Firecamp Offers?
36+
### 🔬 Features
37+
3338
Firecamp offers you a broad range of features that will help you build APIs faster than ever.
3439

35-
| | <div style="width:290px">Roadmap</div> | Status |
36-
| :---: | :--- | :--- |
37-
| :white_check_mark: | [**1. API Collection**](https://firecamp.io/docs/platform/collection) <br/> Manage Collection of APIs to collaborate within team | `completed` |
38-
| :white_check_mark: | [**2. API Playgrounds**](https://firecamp.io/docs/rest/introduction) <br/> Get instant playgrounds for your APIs. Rest, GraphQL, and more. | `completed` |
39-
| :white_check_mark: | [**3. API Collaboration**](https://firecamp.io/docs/collaboration/getting-started) <br/> Collaborate with your team at a centralized shared workspace. | `completed` |
40-
| :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` |
41-
| :white_check_mark: | [**5. API Scripts**](https://firecamp.io/docs/platform/scripts) <br/> Interpret the API with pre-request and tests scripts | `completed` |
42-
| :white_check_mark: | [**6. Dynamic Variables**](https://firecamp.io/docs/platform/environment) <br/> Set values in variables to reuse in whole platform dynamically | `completed` |
43-
| :white_check_mark: | [**7. API Workspaces**](https://firecamp.io/docs/collaboration/creating-workspace) <br/> Create multiple workspaces for better team collaboration | `completed` |
44-
| :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` |
45-
| :white_check_mark: | [**9. Firecamp Web**](https://firecamp.dev) <br/> Get quick access to web platform | `completed` |
46-
| :runner: | **10. Desktop Apps** <br/> Get the Desktop app for your preferred OS/platform | `in-progress` |
47-
| :runner: | **11. API Test Runner** <br/> Run the API Collection visually within the platform | `in-progress` |
48-
| :runner: | **12. API Documentation** <br/> Publish beautiful API documentation for your team and community | `in-progress` |
49-
| :dart: | **13. SSL** <br/> Use custom SSL certificates to test out the SSL-secured API endpoints | `planned` |
50-
| :dart: | **14. Proxy** <br/> Setup proxy while running requests from Firecamp | `planned` |
51-
| :dart: | **15. Artificial Intelligence** <br/> Cutting-edge AI-powered capabilities | `planned` |
52-
| :dart: | **16. History** <br/> Seamless history tracking | `planned` |
40+
📂 [Collection](https://firecamp.io/docs/platform/collection) :
41+
Manage Collection of APIs to collaborate within team <br/>
42+
43+
[API Playgrounds](https://firecamp.io/docs/rest/introduction) :
44+
Get instant playgrounds for your APIs. Rest, GraphQL, and more <br/>
45+
46+
♻️ [Team Collaboration](https://firecamp.io/docs/collaboration/getting-started) :
47+
Collaborate with your team at a centralized shared workspace <br/>
48+
49+
🔐 [Authentication](https://firecamp.io/docs/platform/authentication) :
50+
Test and Debug your auth endpoints with a range of supported auths <br/>
51+
52+
📠 [Scripts](https://firecamp.io/docs/platform/scripts) :
53+
Interpret the API with pre-request and tests scripts <br/>
54+
55+
🔩 [Dynamic Variables](https://firecamp.io/docs/platform/environment) :
56+
Set values in variables to reuse in whole platform dynamically <br/>
57+
58+
🔁 [CLI & CI/CD](https://firecamp.io/docs/cli/getting-started) :
59+
Run API Collection Tests in the terminal or set in CI/CD pipeline <br/>
60+
61+
📡 [Firecamp Web](https://firecamp.dev) :
62+
Get quick access to web platform <br/>
63+
64+
💻 Desktop Apps : Get the Desktop app for your preferred OS/platform <br/>
65+
66+
➿ API Test Runner : Run the API Collection visually within the platform </br>
67+
68+
📄 API Documentation : Publish beautiful API documentation for your team and community </br>
69+
70+
⚓ SSL : Use custom SSL certificates to test out the SSL-secured API endpoints </br>
71+
72+
📝 Proxy : Setup proxy while running requests from Firecamp </br>
73+
74+
☑️ Artificial Intelligence : Cutting-edge AI-powered capabilities </br>
75+
76+
ℹ️ History : Seamless history tracking
77+
5378

5479
### API Playgrounds
5580
There is a dedicated GUI playground for each API protocol you would be using for your stack.
5681

57-
| | |
58-
| :--- | :--- |
59-
| :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. |
60-
| :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.|
61-
| :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. |
62-
| :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.| |
63-
| 🎯 | **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=) |
82+
1. [**Rest Playground**](https://firecamp.io/docs/rest/introduction)
83+
It's the lightweight, IntelliSense, and next-generation testing client to give the most delightful collaborative experience while building APIs in a team.
84+
85+
2. [**GraphQL Playground**](https://firecamp.io/docs/graphql/introduction)
86+
Perform GraphQL operations with a seamless experience. Prepare, Share, and Export your Query Collection collaboratively with your team.
87+
88+
3. [**WebSocket Playground**](https://firecamp.io/docs/websocket/introduction)
89+
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.
90+
91+
4. [**Socket.io Playground**](https://firecamp.io/docs/socket-io/introduction)
92+
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.
93+
94+
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=)
95+
96+
### Get Involved
97+
98+
Here is the [guide for contributions](https://github.com/firecamp-dev/firecamp/blob/main/CONTRIBUTING.md) to help you begin your journey in contributing.
6499

65-
### Community and Support
100+
### 🏆 Community and Support
66101

67102
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.
68103

@@ -73,23 +108,18 @@ Here are helpful links for Firecamp
73108

74109
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.
75110

76-
### Philosophy
111+
### 💭 Philosophy
77112
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.
78113
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.
79114
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.
80115

81-
### What's cool about this?
116+
### 🏄 What's cool about this?
82117

83118
Firecamp is a Multi-protocol API platform, which offers end-to-end testing and development of Rest, GraphQL, WebSocket, and many other APIs.
84119
We support major API specifications and protocols, which allows for seamless API testing, API documentation, and smoother collaboration between backend, frontend, and mobile teams.
85120

86-
### Internet Mentions
87-
1. https://dev.to/firecampdev/lightweight-postman-alternative-introducing-firecamp-3066
88-
2. https://www.asyncapi.com/blog/socketio-automatic-docs
89-
3. https://twitter.com/Nishchit14/status/1679523569091633153
90-
91121

92-
### Contributors
122+
### 💎 Contributors
93123

94124
<a href="https://github.com/firecamp-dev/firecamp/graphs/contributors">
95125
<img src="https://contrib.rocks/image?repo=firecamp-dev/firecamp" />

readme/README.v1.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Firecamp is a dx-first API development platform that helps developers design, de
1515

1616
live at https://firecamp.dev
1717

18+
![firecamp-cover (12)](https://github.com/firecamp-dev/firecamp/assets/5078921/1ef25fd3-bf97-4bd0-b440-7c1f4ef3eb22)
19+
1820
----
1921

2022
### Getting started with Firecamp

readme/README.v2.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
2+
3+
![FirecampCoverImage](.github/github-cover.png)
4+
5+
![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)
6+
[![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)
7+
[![Firecamp Discord](https://badgen.net/discord/members/8hRaqhK)](https://discord.gg/8hRaqhK)
8+
9+
# 🔥 Firecamp
10+
dx-first api devtool
11+
12+
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.
13+
14+
- 🌈 best-in-class developer experience inspired by vscode dx. <br/>
15+
- 📡 multi-protocol testing capabilities with Rest, GraphQL, Websocket, and SocketIO APIs. <br/>
16+
- 👐 collaborate on api collections across the workspace and team <br/>
17+
- ⛺ build apis faster without switching between tools and apps. documentation, cli, ci/cd under one roof <br/>
18+
19+
20+
👉 live at https://firecamp.dev
21+
22+
![alt text](https://user-images.githubusercontent.com/5078921/262089548-1ef25fd3-bf97-4bd0-b440-7c1f4ef3eb22.png)
23+
24+
25+
26+
### 🚀 Getting started with Firecamp
27+
To get started with Firecamp, follow these steps:
28+
29+
1. Sign in to Firecamp at https://firecamp.dev
30+
2. Follow the [Getting Started](https://firecamp.io/docs) guide from the documentation.
31+
3. Start developing, and testing your APIs using Firecamp.
32+
33+
Read the Firecamp doc for in-depth walk-throughs on functionality to understand the various features and capabilities of Firecamp.
34+
35+
36+
### 🔬 Features
37+
38+
Firecamp offers you a broad range of features that will help you build APIs faster than ever.
39+
40+
📂 [Collection](https://firecamp.io/docs/platform/collection) :
41+
Manage Collection of APIs to collaborate within team <br/>
42+
43+
[API Playgrounds](https://firecamp.io/docs/rest/introduction) :
44+
Get instant playgrounds for your APIs. Rest, GraphQL, and more <br/>
45+
46+
♻️ [Team Collaboration](https://firecamp.io/docs/collaboration/getting-started) :
47+
Collaborate with your team at a centralized shared workspace <br/>
48+
49+
🔐 [Authentication](https://firecamp.io/docs/platform/authentication) :
50+
Test and Debug your auth endpoints with a range of supported auths <br/>
51+
52+
📠 [Scripts](https://firecamp.io/docs/platform/scripts) :
53+
Interpret the API with pre-request and tests scripts <br/>
54+
55+
🔩 [Dynamic Variables](https://firecamp.io/docs/platform/environment) :
56+
Set values in variables to reuse in whole platform dynamically <br/>
57+
58+
🔁 [CLI & CI/CD](https://firecamp.io/docs/cli/getting-started) :
59+
Run API Collection Tests in the terminal or set in CI/CD pipeline <br/>
60+
61+
📡 [Firecamp Web](https://firecamp.dev) :
62+
Get quick access to web platform <br/>
63+
64+
💻 Desktop Apps : Get the Desktop app for your preferred OS/platform <br/>
65+
66+
➿ API Test Runner : Run the API Collection visually within the platform </br>
67+
68+
📄 API Documentation : Publish beautiful API documentation for your team and community </br>
69+
70+
⚓ SSL : Use custom SSL certificates to test out the SSL-secured API endpoints </br>
71+
72+
📝 Proxy : Setup proxy while running requests from Firecamp </br>
73+
74+
☑️ Artificial Intelligence : Cutting-edge AI-powered capabilities </br>
75+
76+
ℹ️ History : Seamless history tracking
77+
78+
79+
### API Playgrounds
80+
There is a dedicated GUI playground for each API protocol you would be using for your stack.
81+
82+
1. [**Rest Playground**](https://firecamp.io/docs/rest/introduction)
83+
It's the lightweight, IntelliSense, and next-generation testing client to give the most delightful collaborative experience while building APIs in a team.
84+
85+
2. [**GraphQL Playground**](https://firecamp.io/docs/graphql/introduction)
86+
Perform GraphQL operations with a seamless experience. Prepare, Share, and Export your Query Collection collaboratively with your team.
87+
88+
3. [**WebSocket Playground**](https://firecamp.io/docs/websocket/introduction)
89+
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.
90+
91+
4. [**Socket.io Playground**](https://firecamp.io/docs/socket-io/introduction)
92+
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.
93+
94+
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=)
95+
96+
### Get Involved
97+
98+
Here is the [guide for contributions](https://github.com/firecamp-dev/firecamp/blob/main/CONTRIBUTING.md) to help you begin your journey in contributing.
99+
100+
### 🏆 Community and Support
101+
102+
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.
103+
104+
Here are helpful links for Firecamp
105+
- [Documentation](https://firecamp.io/docs)
106+
- [Discord community](https://discord.gg/8hRaqhK)
107+
- [Twitter updates](https://twitter.com/FirecampDev)
108+
109+
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.
110+
111+
### 💭 Philosophy
112+
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.
113+
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.
114+
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.
115+
116+
### 🏄 What's cool about this?
117+
118+
Firecamp is a Multi-protocol API platform, which offers end-to-end testing and development of Rest, GraphQL, WebSocket, and many other APIs.
119+
We support major API specifications and protocols, which allows for seamless API testing, API documentation, and smoother collaboration between backend, frontend, and mobile teams.
120+
121+
122+
### 💎 Contributors
123+
124+
<a href="https://github.com/firecamp-dev/firecamp/graphs/contributors">
125+
<img src="https://contrib.rocks/image?repo=firecamp-dev/firecamp" />
126+
</a>

0 commit comments

Comments
 (0)