backup/EWF
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Jocelyn FIAT
2014-01-27 10:10:41 +01:00
parent 991389e9b9
commit f5c2f9e017
1 changed files with 25 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -3,6 +3,27 @@
## Overview ## Overview
The Eiffel Web Framework (EWF) provides Eiffel users with a layer to build anything on top of the http protocol such as websites, web API/services.
This layer is multi-platform: it can be set on Windows, Linux operating systems, and in addition it can run on top of any httpd servers such as Apache2, IIS, nginx, lighttpd. EWF includes as well a standalone httpd web server component, written in Eiffel, which enables users to run easily a web server on their machine, or even embed this component in any application written with Eiffel.
Currently EWF offers a collection of Eiffel libraries designed to be integrated with each others, and among other functionalities, it give simple access to the request data, to handle content negotiation, url dispatcher, integrate with openid system, and so on.
There is a growing ecosystem around EWF, that provides useful components:
* OpenID and OAuth consumer library
* Various hypermedia format such as HAL, Collection+json, …
* Websocket server and client
* Template engine
* API Auto-documentation with swagger
* A simple experimental CMS.
* ...
So if you want to build a website, a web api, RESTful service, …or even if you want to consume other web api, EWF is a solution.
EWF brings with it all the advantages of the Eiffel technology and tools with its powerful features such as Design by Contract, debugging, testing tools which enable to build efficient systems expected to be repeatedly refined, extended, and improved in a predictable and controllable way so as to become with time bugfree systems. Enjoy the full power of debugging your web server application from the IDE.
## Project
Official project site for Eiffel Web Framework: Official project site for Eiffel Web Framework:
* http://eiffelwebframework.github.com/EWF/ * http://eiffelwebframework.github.com/EWF/
@@ -15,9 +36,9 @@ For download, check
* https://github.com/EiffelWebFramework/EWF/downloads * https://github.com/EiffelWebFramework/EWF/downloads
## Requirements ## Requirements
* Compiling from EiffelStudio 7.2 * Compiling from EiffelStudio 7.2 to 13.11 and more recent version of the compiler.
* Developped using EiffelStudio 7.3 (on Windows, Linux) * Developped using EiffelStudio 13.11 (on Windows, Linux)
* Tested using EiffelStudio 7.2 with "jenkins" CI server (not anymore compatible with 6.8 due to use of `TABLE_ITERABLE') * Tested using EiffelStudio 13.11 with "jenkins" CI server (not anymore compatible with 6.8 due to use of `TABLE_ITERABLE')
* The code have to allow __void-safe__ compilation and non void-safe system (see [more about void-safety](http://docs.eiffel.com/book/method/void-safe-programming-eiffel) ) * The code have to allow __void-safe__ compilation and non void-safe system (see [more about void-safety](http://docs.eiffel.com/book/method/void-safe-programming-eiffel) )
## How to get the source code? ## How to get the source code?
@@ -41,7 +62,7 @@ Using git
### protocol ### protocol
* __http__: HTTP related classes, constants for status code, content types, ... [read more](library/protocol/http) * __http__: HTTP related classes, constants for status code, content types, ... [read more](library/protocol/http)
* __uri_template__: URI Template library (parsing and expander) [read more](library/protocol/uri_template) * __uri_template__: URI Template library (parsing and expander) [read more](library/protocol/uri_template)
* __CONNEG__: CONNEG library (Content-type Negociation) [read more](library/protocol/CONNEG) * __CONNEG__: Content negotiation library (Content-type Negociation) [read more](library/protocol/content_negotiation)
### client ### client
* __http_client__: simple HTTP client based on cURL [read more](library/client/http_client) * __http_client__: simple HTTP client based on cURL [read more](library/client/http_client)