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

Updated README to reflect release of Alpha-1.0

Browse source
This commit is contained in:
Rohit Awate 2018-04-23 18:40:52 +05:30 committed by GitHub
parent 9e4bd868b5
commit 851c2415b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -1,20 +1,23 @@
![everestheader](https://user-images.githubusercontent.com/23148259/39124644-c886b47a-4719-11e8-953c-f079b3edb664.png) ![everestheader](https://user-images.githubusercontent.com/23148259/39124644-c886b47a-4719-11e8-953c-f079b3edb664.png)
Everest _(formerly **RESTaurant**)_ is an upcoming native REST client written in JavaFX. ----
Everest _(formerly RESTaurant)_ is an upcoming REST API testing client written in JavaFX.
![default](https://user-images.githubusercontent.com/23148259/39123684-2f7df138-4716-11e8-8ff8-589a1cc47834.PNG) ![default](https://user-images.githubusercontent.com/23148259/39123684-2f7df138-4716-11e8-8ff8-589a1cc47834.PNG)
_Everest running on Windows 10._ _Everest running on Windows 10._
# Why Everest? # Why Everest?
- Unlike other REST clients like Postman and Insomnia, Everest is a **native** application written in Java. Thus, it is significantly - Unlike other REST clients like Postman and Insomnia, Everest is written in Java. Thus, it is significantly
**lighter on resources and more responsive** than the Electron-based options. The goal with Everest is to provide pretty much the same **lighter on resources and more responsive** than the Electron-based options. The goal with Everest is to provide pretty much the same
level of functionality as the formerly mentioned options, but in a lighter, native but equally slick package. It is a big and slightly arrogant bet, level of functionality as the other options, but in a lighter, native but equally slick package. It is a big and slightly arrogant bet,
but then I don't think anyone other than me would use this! So heck, at least I'll learnt a lot. _Not bad for a Comp Sci student, eh?_ but then I don't think anyone other than me would use this! So heck, at least I'll learnt a lot. _Not bad for a Comp Sci student, eh?_
- In all of my projects, design is of paramount importance. And Everest is no exception. - In all of my projects, design is of paramount importance. And Everest is no exception.
With a **gorgeous, flat design and a neutral color scheme**, Everest is a pleasure to look at and to work with. With a **gorgeous, flat design and a neutral color scheme**, Everest is a pleasure to look at and to work with.
_I want you to want to use it!_ _I want you to want to use it!_
- Being a Java application, Everest is inherently **cross-platform**. It will run anywhere there's a JVM.
- Everest is powered by **Jersey**, the robust and powerful Java library to build and consume RESTful web services. - Everest is powered by **Jersey**, the robust and powerful Java library to build and consume RESTful web services.
![get](https://user-images.githubusercontent.com/23148259/39123790-8a828b34-4716-11e8-8913-62a6356dd36e.PNG) ![get](https://user-images.githubusercontent.com/23148259/39123790-8a828b34-4716-11e8-8913-62a6356dd36e.PNG)
_Making a GET request with Everest._ _Making a GET request with Everest._
# Planned features # Planned features
@ -31,15 +34,15 @@ _Making a GET request with Everest._
_That's all the core stuff that I can think of at the moment. Will keep updating this as we go._ _That's all the core stuff that I can think of at the moment. Will keep updating this as we go._
## Not-so-certain features ## Not-so-certain features
- Suggestions as you type in the address field. - Text prediction for the address bar based on your history.
- Postman has this really cool feature wherein it can create a **mock server**. Maybe do that. - Postman has this really cool feature wherein it can create a **mock server**. I'll do that once the core features are implemented and if it doesn't severely impact performance.
![error](https://user-images.githubusercontent.com/23148259/39123851-d52d250e-4716-11e8-9c52-800fd708dc2b.PNG) ![error](https://user-images.githubusercontent.com/23148259/39123851-d52d250e-4716-11e8-9c52-800fd708dc2b.PNG)
# Features currently live # Features currently live
- GET, POST, PUT and DELETE requests. - GET, POST, PUT, DELETE and PATCH requests.
- Adding request headers, query parameters and the request body (raw, octet-stream, URL-encoded or form-data) - Adding request headers, query parameters and the request body (raw, octet-stream, URL-encoded or form-data)
- Response details (HTTP status code, response time, response size) - 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. - **Custom themes!** Changing themes needs a manual edit to the settings.json file. This will be properly integrated into a Settings menu later.
@ -52,9 +55,17 @@ _That's all the core stuff that I can think of at the moment. Will keep updating
_Everest's search feature in action._ _Everest's search feature in action._
# Releases # Releases
An alpha release is available via Releases. A couple of things to note: The first alpha release is available [here](https://github.com/RohitAwate/Everest/releases/tag/Alpha-1.0).
- API authentication is not available. Make sure you read the release notes to better understand the release.
- The BugReporter currently only generates a bug report but doesn't send it to us. Kindly use GitHub Issues for issue submission.
# Suggestions and improvements
Use these options to reach me:
- Open a GitHub issue.
- Email me at rohitawate121@gmail.com.
- Tweet me at [@TheRohitAwate](https://twitter.com/TheRohitAwate)
Aaaand, that's it! Aaaand, that's it!
I don't think anyone will make it down here. But if you did, you're awesome and thanks! _Cheers!_ I don't think anyone will make it down here. But if you did, you're awesome! 🏆
_Cheers!_