Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #48 from firecamp-dev/readme
Readme changes
- Loading branch information
Showing
4 changed files
with
141 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
|  | ||
|
|
||
| [](https://discord.gg/8hRaqhK) | ||
| [](https://twitter.com/firecampdev) | ||
|
|
||
| # Firecamp | ||
| DX-focused API development platform. | ||
|
|
||
| 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. | ||
|
|
||
| - 💚 VSCode-driven Developer Experience | ||
| - :high_brightness: Multi-protocol testing capabilities with Rest, GraphQL, Websocket, and SocketIO APIs. | ||
| - :satellite: Collaborate on API collection across the team | ||
| - 🏗️ Build APIs faster without switching between tools and apps. | ||
|
|
||
| Try it now 🏕️ https://firecamp.dev | ||
|
|
||
| ## Getting started with Firecamp | ||
| To get started with Firecamp, follow these steps: | ||
|
|
||
| 1. Sign in to Firecamp at https://firecamp.dev | ||
| 2. Follow the [Getting Started](https://firecamp.io/docs) guide from the documentation. | ||
| 3. Start developing, and testing your APIs using Firecamp. | ||
|
|
||
| Read the Firecamp doc for in-depth walk-throughs on functionality to understand the various features and capabilities of Firecamp. | ||
|
|
||
|
|
||
| ## What Firecamp Offers? | ||
| Firecamp offers you a broad range of features that will help you build APIs faster than ever. | ||
|
|
||
| | <div style="width:290px"></div> | | | | ||
| |---:|:---:|:---| | ||
| | <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 a centralized shared workspace.| | ||
| | <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| | ||
| | <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` | <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`| <br/> **13. SSL** <br/> Use custom SSL certificates to test out the SSL secured API endpoints`Status: Planned`| <br/> **14. Proxy** <br/> Setup proxy while running requests from Firecamp `Status: Planned`| | ||
|
|
||
| ## API Playgrounds | ||
| There is a dedicated GUI playground for each API protocol you would be using for your stack. | ||
|
|
||
| ### :one: **Rest Playground** | ||
| It's the lightweight, IntelliSense, and next-generation testing client to give the most delightful collaborative experience while building APIs in a team. | ||
|
|
||
| [Learn more](https://firecamp.io/docs/rest/introduction) | ||
|
|
||
| ### :two: **GraphQL Playground** | ||
| Perform GraphQL operations with a seamless experience. Prepare, Share, and Export your Query Collection collaboratively with your team. | ||
|
|
||
| [Learn more](https://firecamp.io/docs/graphql/introduction) | ||
|
|
||
| ### :three: **WebSocket Playground** | ||
| 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. | ||
|
|
||
| [Learn more](https://firecamp.io/docs/websocket/introduction) | ||
|
|
||
| ### :four: **Socket.io Playground** | ||
| 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. | ||
|
|
||
| [Learn more](https://firecamp.io/docs/socket-io/introduction) | ||
|
|
||
| ### :five: What's next? | ||
| please [let us know](https://github.com/firecamp-dev/Firecamp/issues/new?assignees=&labels=&projects=&template=general_report.md&title=) | ||
|
|
||
| ## 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. | ||
|
|
||
| Here are helpful links for Firecamp | ||
| - [Documentation](https://firecamp.io/docs) | ||
| - [Discord community](https://discord.gg/8hRaqhK) | ||
| - [Twitter updates](https://twitter.com/FirecampDev) | ||
|
|
||
| If you encounter any bugs, issues, or have suggestions, please open an issue on the [Firecamp GitHub repository](https://github.com/firecamp-dev/Firecamp). We appreciate your contributions to make Firecamp even better. | ||
|
|
||
|
|
||
| ## Roadmap | ||
| Here is the Firecamp development roadmap. Very soon It'll be listed on Github projects for better project management. | ||
| - **AI: Cutting-edge AI-powered capabilities** | ||
| - **Firecamp CLI:** developer-friendly CLI tool | ||
| - **Test Runner:** An advanced API test runner | ||
| - **Proxy:** A versatile built-in proxy | ||
| - **SSL:** Robust SSL support | ||
| - **History:** Seamless history tracking | ||
| - **DX:** Improved developer experience | ||
| - **Documentation:** Enhanced API documentation | ||
| - **CI/CD:** Seamless integration with CI/CD workflows | ||
| - Undisclosed Platform Phase-2 | ||
|
|
||
| ## 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. | ||
| 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. | ||
|
|
||
| ## 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. | ||
| 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 | ||
|
|
||
| <a href="https://github.com/firecamp-dev/firecamp/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=firecamp-dev/firecamp" /> | ||
| </a> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters