Skip to content

Commit 8a4f454

Browse files
authored
Update README.v2.md
1 parent b5eb24e commit 8a4f454

1 file changed

Lines changed: 45 additions & 34 deletions

File tree

β€Žreadme/README.v2.mdβ€Ž

Lines changed: 45 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
1+
<p align="center">
2+
<a href="https://firecamp.dev">
3+
<img src="https://github.com/firecamp-dev/firecamp/blob/main/.github/logo.svg" alt="Firecamp Logo" width="70">
4+
</a>
5+
</p>
16

7+
<h3 align="center"><b>Firecamp</b></h3>
8+
<p align="center"><b>dx-first open-source api devtool</b></p>
29

3-
![FirecampCoverImage](.github/github-cover.png)
10+
<p align="center">
11+
<a href="https://discord.gg/8hRaqhK">
12+
<img alt="Discord online members" src="https://badgen.net/discord/members/8hRaqhK?color=5865F2&label=Discord&style=for-the-badge" />
13+
</a>
14+
</p>
415

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)
16+
<p align="center">
17+
<a href="https://firecamp.dev">
18+
<img alt ="firecamp-cover" src="https://github.com/firecamp-dev/firecamp/assets/5078921/1ef25fd3-bf97-4bd0-b440-7c1f4ef3eb22"/>
19+
</a>
20+
</p>
821

922
# πŸ”₯ Firecamp
10-
dx-first api devtool
1123

1224
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.
1325

@@ -19,11 +31,8 @@ Firecamp is a dx-first API development platform that helps developers design, de
1931

2032
πŸ‘‰ live at https://firecamp.dev
2133

22-
![alt text](https://user-images.githubusercontent.com/5078921/262089548-1ef25fd3-bf97-4bd0-b440-7c1f4ef3eb22.png)
23-
2434

25-
26-
### πŸš€ Getting started with Firecamp
35+
## πŸš€ Getting started with Firecamp
2736
To get started with Firecamp, follow these steps:
2837

2938
1. Sign in to Firecamp at https://firecamp.dev
@@ -33,7 +42,7 @@ To get started with Firecamp, follow these steps:
3342
Read the Firecamp doc for in-depth walk-throughs on functionality to understand the various features and capabilities of Firecamp.
3443

3544

36-
### πŸ”¬ Features
45+
## πŸ”¬ Features
3746

3847
Firecamp offers you a broad range of features that will help you build APIs faster than ever.
3948

@@ -55,28 +64,11 @@ Interpret the API with pre-request and tests scripts <br/>
5564
πŸ”© [Dynamic Variables](https://firecamp.io/docs/platform/environment) :
5665
Set values in variables to reuse in whole platform dynamically <br/>
5766

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-
6167
πŸ“‘ [Firecamp Web](https://firecamp.dev) :
6268
Get quick access to web platform <br/>
6369

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-
7870

79-
### API Playgrounds
71+
## πŸ•οΈ API Playgrounds
8072
There is a dedicated GUI playground for each API protocol you would be using for your stack.
8173

8274
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
9183
4. [**Socket.io Playground**](https://firecamp.io/docs/socket-io/introduction)
9284
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.
9385

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=)
86+
## πŸ›£οΈ Roadmap
87+
88+
89+
πŸ’» Desktop Apps : Get the Desktop app for your preferred OS/platform <br/>
90+
91+
πŸ›°οΈ Self-hosted : Host Firecamp on your own server
92+
93+
πŸ” CLI & CI/CD : Run API Collection Tests in the terminal or set in CI/CD pipeline <br/>
94+
95+
➿ API Test Runner : Run the API Collection visually within the platform </br>
96+
97+
πŸ“„ API Documentation : Publish beautiful API documentation for your team and community </br>
98+
99+
βš›οΈ Artificial Intelligence : Cutting-edge AI-powered capabilities </br>
100+
101+
βš“ SSL : Use custom SSL certificates to test out the SSL-secured API endpoints </br>
102+
103+
πŸ“ Proxy : Setup proxy while running requests from Firecamp </br>
104+
105+
ℹ️ History : Seamless history tracking
95106

96-
### Get Involved
107+
## πŸ“‘ Get Involved
97108

98109
Here is the [guide for contributions](https://github.com/firecamp-dev/firecamp/blob/main/CONTRIBUTING.md) to help you begin your journey in contributing.
99110

100-
### πŸ† Community and Support
111+
## πŸ† Community and Support
101112

102113
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.
103114

@@ -108,18 +119,18 @@ Here are helpful links for Firecamp
108119

109120
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.
110121

111-
### πŸ’­ Philosophy
122+
## πŸ’­ Philosophy
112123
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.
113124
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.
114125
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.
115126

116-
### πŸ„ What's cool about this?
127+
## πŸ„ What's cool about this?
117128

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

121132

122-
### πŸ’Ž Contributors
133+
## πŸ’Ž Contributors
123134

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

0 commit comments

Comments
Β (0)