README.md in nephos-server-0.4.8 vs README.md in nephos-server-0.5.0
- old
+ new
@@ -1,40 +1,40 @@
# Nephos Ruby Server
[](http://badge.fury.io/gh/pouleta%2FNephosRubyServer)
-[](http://badge.fury.io/rb/nephos-server)
+[](http://badge.fury.io/rb/nserver)
[](https://codeclimate.com/github/pouleta/NephosRubyServer)
This is a minimal web server, based on [rack](TODO LINK) and [puma](TODO LINK).
It is written in ruby. It also gives you a minimal architecture
-to speed up your application creation.
+to speed up your application bootstrap.
Features provided:
- Controllers: gives you a resource logic.
- Render: easier render content to the client.
- Router: create a robust and simple routing system, with url variables.
-Features wich will not be provided by nephos-server:
+Features which will not be provided by nserver:
-- Templating (HTML with variables, loops, ...): It already exists and they are easy to implement.
+- Templating (HTML with variables, loops, ...): It already exists and it is easy to implement.
- [Slim](DOCUMENTATION/TEMPLATING/SLIM.md)
-- Database orm and connector: It already exists and simple to implement
+- Database orm and connector: It already exists and simple to implement too.
- [Sequel](DOCUMENTATION/DATABASE/SEQUEL.md)
# Start
```sh
-gem install nephos-server # download the server
-nephos-generator application MyApp # generate the application
+gem install nephos # download the server and executables
+ngenerator application MyApp # generate the application
cd MyApp # go in
-nephos-server -p 8080 -h 0.0.0.0 # start the server. port is not required, neither host
+nserver -p 8080 -h 0.0.0.0 # start the server. port is not required, neither host
```
-``nephos-server`` is a binary designed to start the server easly. It can take few arguments, all optionnal:
+``nserver`` is an executable designed to start the server easly. It can take few arguments, all optionnal:
- ``-p``: port to listen
- ``-h``: host to listen (network address)
- ``-e``: environment (default is development, can be set to production)
@@ -51,17 +51,18 @@
## Examples
### Production
-To avoid information leaks from your application, set the environment variable ``export ENVIRONMENT=production``.
+To avoid information leaks from your application, set the environment variable ``export ENVIRONMENT=production``,
+or run the server with ``-e production`` parameter.
It will disable ruby error messages when an error occurs in the controller.
### Controller
To create a controller, add a ruby file to ``app/``, with a class inherited by ``Nephos::Controller``
-The basic code of a controller can be generated via ``nephos-generator controller NAME``.
+The basic code of a controller can be generated via ``ngenerator controller NAME``.
```ruby
class Example < Nephos::Controller
def root
if params["index"] == "true"
@@ -89,39 +90,36 @@
```
### Routing
The routing (rules to execute the action the user wants), you have to write the ``/routes.rb`` file.
-if the user try to access to an url not described in the file, it will automaticaly render a 404 not found.
+If the user try to access an url not described in the file, it will automaticaly render a 404 not found.
```ruby
get url: "/", controller: "MainController", method: "root" # /
-get url: "/add", controller: "MainController", method: "add_url" # /add
-get url: "/add/:url", controller: "MainController", method: "add_url" # /add with parameter :url
-get url: "/rm", controller: "MainController", method: "rm_url" # /rm
-get url: "/rm/:url", controller: "MainController", method: "rm_url" # /rm with parameter :url
+post url: "/add", controller: "MainController", method: "add_url" # /add
+post url: "/add/:url", controller: "MainController", method: "add_url" # /add with parameter :url
+put url: "/rm", controller: "MainController", method: "rm_url" # /rm
+put url: "/rm/:url", controller: "MainController", method: "rm_url" # /rm with parameter :url
resource "infos" do
get url: "/", controller: "MainController", method: "root" # generate /infos
- get url: "/abbout", controller: "MainController", method: "root" # generate /infos/about
+ get url: "/about", controller: "MainController", method: "root" # generate /infos/about
end
```
# Developers: Roadmap
-## TODO v0.4
-- improve generator with application tests
-- improve executables (tests, arguments)
-- improve documentation (bin)
-
## TODO v0.5
- executables with version
- cookies, ...
- usage of rack parsers (Rack::Request.new(env) etc.)
## TODO v0.6
- startable as daemon
- hooks for controller
+- feature to change HTTP header from controller
+- customisable default 404 errors and 500 errors
## v1 requierements
- Environement, Daemons, Port, Listen Host, Routables, Arguments
- Generator readables and powerfull
- At least 80% tests coverage