Skip to content

Commit a48c755

Browse files
authored
Merge pull request #19 from FirecampDev/readme
Readme Updated
2 parents 43e1cf6 + bcfba15 commit a48c755

File tree

1 file changed

+66
-36
lines changed

1 file changed

+66
-36
lines changed

README.md

Lines changed: 66 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,100 @@
1-
![FirecampCoverImage](.github/github-cover.png)
21

2+
![FirecampCoverImage](.github/github-cover.png)
33

44
[![Firecamp Discord](https://badgen.net/discord/members/8hRaqhK)](https://discord.gg/8hRaqhK)
55
[![Twitter: Firecamp](https://img.shields.io/twitter/follow/firecampdev.svg?style=social)](https://twitter.com/firecampdev)
66

7-
# Firecamp is a Multi-protocol API development platform, for developers.
7+
# Firecamp
8+
DX-focused API development platform.
89

9-
💚 VSCode-driven Developer Experience
10+
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, Firecamp streamlines the API development workflow and enhances collaboration among team members.
1011

11-
:high_brightness: End to End testing of Rest, GraphQL, Websocket and SocketIO APIs
12+
- 💚 VSCode-driven Developer Experience=
13+
- :high_brightness: Multi-protocol testing capabilities with Rest, GraphQL, Websocket, and SocketIO APIs.
14+
- :satellite: Collaborate on API collection across the team
15+
- 🏗️ Build APIs faster without switching between tools and apps.
16+
17+
Try it now 🏕️ https://firecamp.dev
1218

13-
:satellite: Collaborate on API collection across the team
19+
## Getting started with Firecamp
20+
To get started with Firecamp, follow these steps:
1421

15-
🏗️ Build APIs faster without switching between tools and apps.
22+
1. Sign in to Firecamp at https://firecamp.dev
23+
2. Follow the [Getting Started](https://firecamp.io/docs) guide from the documentation.
24+
3. Start developing, and testing your APIs using Firecamp.
1625

17-
## Firecamp application
18-
🏕️ https://firecamp.dev
26+
Read the Firecamp doc for in-depth walk-throughs on functionality to understand the various features and capabilities of Firecamp.
1927

20-
## Features
21-
We give you a broad range of features that will help you build APIs faster than ever.
2228

23-
- **Account**: Create your Firecamp account with Github, Google, and Email and sync your data across devices and the cloud.
29+
## What Firecamp Offers?
30+
Firecamp offers you a broad range of features that will help you build APIs faster than ever.
2431

25-
- **Collection**: Collect and organise your APIs through the “collection and folder” feature.
32+
| | | |
33+
|:---|:---|:---|
34+
| <br/> [**1. API Collection**](https://firecamp.io/docs/platform/collection) <br/> Manage Collection of APIs to collaborate within team| <br/> [**2. API Playgrounds**](https://firecamp.io/docs/rest/introduction) <br/> Get instant playgrounds for your APIs. Rest, GraphQL, and more. | <br/> [**3. API Collaboration**](https://firecamp.io/docs/collaboration/getting-started) <br/> Collaborate with your team at centralize shared workspace.|
35+
| <br/> [**4. API Authentication**](https://firecamp.io/docs/platform/authentication) <br/> Test and Debug your auth endpoints with a range of supported auths| <br/> [**5. API Scripts**](https://firecamp.io/docs/platform/scripts) <br/> Interpret the API with pre-request and tests scripts | <br/> [**6. Dynamic Variables**](https://firecamp.io/docs/platform/environment) <br/> Set values in variables to reuse in whole platform dynamically|
36+
| <br/> [**7. API Workspaces**](https://firecamp.io/docs/collaboration/creating-workspace) <br/> Create multiple workspaces for better team collaboration| <br/> [**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 | <br/> **9. API Test Runner** <br/> Run the API Collection visually within the platform `Status: in-progress` |
37+
| <br/> **10. API Documentation** <br/> Publish beautiful API documentation for your team and community `Status: in-progress` | <br/> [**11. Firecamp Web**](https://firecamp.dev) <br/> Get quick access to web platform | <br/> **12. Desktop Apps** <br/> Get the Desktop app for your preferred OS/platform `Status: Planned`|
2638

27-
- **Workspace and team collaboration**: Firecamp allows you to create personal and team workspaces according to your needs. You can create a team workspace and collaborate with unlimited team members for better API development flow.
39+
## API Playgrounds
40+
There is a dedicated GUI playground for each API protocol you would be using for your stack.
2841

29-
- **Environment variables**: You can create environment variables to access and reuse values in the request, collection and workspace.
42+
### :one: **Rest Playground**
43+
It's the lightweight, IntelliSense, and next-generation testing client to give the most delightful collaborative experience while building APIs in a team.
3044

31-
- **Setting** : The setting will help you save your account information, local theme and other information.
45+
[Learn more](https://firecamp.io/docs/rest/introduction)
3246

33-
## Dedicated GUI playground for each API protocol
47+
### :two: **GraphQL Playground**
48+
Perform GraphQL operations with a seamless experience. Prepare, Share, and Export your Query Collection collaboratively with your team.
3449

35-
:cherry_blossom: **HTTP playground**
36-
> It's the light-weight, IntelliSense, and the next-generation testing client to give the most delightful collaborative experience while building APIs in a team.
50+
[Learn more](https://firecamp.io/docs/graphql/introduction)
3751

38-
:sunflower: **GraphQL playground**
39-
> Perform GraphQL operations with a seamless experience. Prepare, Share, and Export your Query Collection collaboratively with your team.
52+
### :three: **WebSocket Playground**
53+
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.
4054

41-
:hibiscus: **WebSocket playground**
42-
> 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.
55+
[Learn more](https://firecamp.io/docs/websocket/introduction)
4356

44-
:maple_leaf: **SocketIo playground**
45-
> Monitor each emitters’ 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.
57+
### :four: **Socket.io Playground**
58+
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.
4659

47-
## Roadmap
48-
- Firecamp CLI
49-
- API Test Runner
50-
- Proxy
51-
- SSL
52-
- History
53-
- AI
60+
[Learn more](https://firecamp.io/docs/socket-io/introduction)
61+
62+
### :five: What's next?
63+
please [let us know](https://github.com/FirecampDev/Firecamp/issues/new?assignees=&labels=&projects=&template=general_report.md&title=)
64+
65+
## Community and Support
5466

55-
## Getting the most of Firecamp
56-
📙 [Documentation](https://firecamp.io/docs)
67+
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.
5768

58-
See the Firecamp doc for in-depth walk-throughs on functionality. Join our [Discord server](https://discord.gg/8hRaqhK) if you need help, want to chat, or are thinking of a new feature. We're here.
69+
Here are helpful links for Firecamp
70+
- [Documentation](https://firecamp.io/docs)
71+
- [Discord community](https://discord.gg/8hRaqhK)
72+
- [Twitter updates](https://twitter.com/FirecampDev)
73+
74+
If you encounter any bugs, issues, or have suggestions, please open an issue on the [Firecamp GitHub repository](https://github.com/FirecampDev/Firecamp). We appreciate your contributions to make Firecamp even better.
75+
76+
77+
## Roadmap
78+
Here is the Firecamp development roadmap. Very soon It'll be listed on Github projects for better project management.
79+
- **AI: Cutting-edge AI-powered capabilities**
80+
- **Firecamp CLI:** developer-friendly CLI tool
81+
- **Test Runner:** An advanced API test runner
82+
- **Proxy:** A versatile built-in proxy
83+
- **SSL:** Robust SSL support
84+
- **History:** Seamless history tracking
85+
- **DX:** Improved developer experience
86+
- **Documentation:** Enhanced API documentation
87+
- **CI/CD:** Seamless integration with CI/CD workflows
88+
- Undisclosed Platform Phase-2
5989

6090
## Philosophy
61-
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.
91+
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.
6292
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.
6393
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.
6494

6595
## What's cool about this?
6696

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

70100
## What's Next?

0 commit comments

Comments
 (0)