wbrawner/Everest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
Rohit Awate 2018-02-13 15:03:32 +05:30 committed by GitHub
parent 1829fd3bb0
commit 26b740feab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,7 +1,7 @@
# RESTaurant
RESTaurant is an upcoming native REST client written in JavaFX. It is currently in the initial stages of development.
![restaurant2](https://user-images.githubusercontent.com/23148259/35549452-ad86c886-05ab-11e8-842d-4ea415b5e3ec.PNG)
![restaurant](https://user-images.githubusercontent.com/23148259/36142398-fd032968-10cd-11e8-8eea-840adb28fe21.PNG)
# Why RESTaurant?
- Unlike other REST clients like Postman and Insomnia, RESTaurant is a **native** application written in Java. Thus, it is significantly
@ -13,14 +13,14 @@ RESTaurant is an upcoming native REST client written in JavaFX. It is currently
_I want you to want to use it!_
- RESTaurant is powered by **Jersey**, the robust and powerful Java library to build and consume RESTful web services.
![restaurant](https://user-images.githubusercontent.com/23148259/35549301-efc1fc12-05aa-11e8-864a-4340e65a0667.PNG)
![restaurant2](https://user-images.githubusercontent.com/23148259/36142456-2cd72658-10ce-11e8-872a-5c2e3eedd398.PNG)
# Planned features
- Ability to make requests with the common HTTP methods. _(duh)_
- **Syntax highlighting**: I had tried using [RichTextFX](https://github.com/FXMisc/RichTextFX) for my text editor,
[Ballad](https://github.com/RohitAwate/Ballad), and failed. And I really don't wish to embed an
online editor like Ace into RESTaurant. So, for the time being, I'm gonna use JavaFX's inbuilt TextArea which doesn't offer syntax highlighting.
- **History tab**, for quickly looking at your request history.
- **History tab**, for quickly looking at your request history. 🕒
- **API Authentication**: This is of course a primary feature of any REST client, but currently, not something I've done or used before.
So I will need some time to learn this stuff.
- Theming support with JavaFX CSS. 🌈
@ -33,13 +33,16 @@ _That's all the core stuff that I can think of at the moment. Will keep updating
- Postman has this really cool feature wherein it can create a **mock server**. Maybe do that.
![restaurant3](https://user-images.githubusercontent.com/23148259/35551949-a4f8f782-05b7-11e8-8b65-f7cfa72399db.PNG)
![restaurant3](https://user-images.githubusercontent.com/23148259/36142488-3fea727c-10ce-11e8-8df1-2b7fd3d59d98.PNG)
# Features currently live
- Adding request headers and the request body (raw and binary)
- GET and POST requests
- Adding request headers and the request body (raw, octet-stream, URL-encoded or form-data)
- GET, POST, PUT and DELETE requests
- Response details (HTTP status code, response time, response size)
- Custom themes! Changing themes needs a manual edit to the settings.json file. This will be properly integrated into a Settings menu later.
- Multi-tab layout. I'm battling with JavaFX to allow me to add a simple '+' button for adding a new tab. So far, not successful. However, you can use the Ctrl+T keyboard shortcut.
- Requests history gets saved to a database. History tab will be coming up soon.
# Releases
I mean, it's open-source. You can build yourself a 'release' right now!
@ -47,7 +50,7 @@ I mean, it's open-source. You can build yourself a 'release' right now!
Jokes aside, I'm planning to release an alpha once the GET, POST, PUT and DELETE methods are up and running.
I'll also add the aforementioned history tab as a bonus, maybe!
**Alpha ETA**: March/April 2018 _(hopefully)_
**Alpha ETA**: March 2018 _(hopefully)_
Aaaand, that's it!
I don't think anyone will make it down here. But if you did, you're awesome and thanks! _Cheers!_