martin/frontexpress
1
0
Fork 0
mirror of https://gitlab.silvrtree.co.uk/martind2000/frontexpress.git synced 2025-01-11 22:05:08 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Camel Aissani 2016-07-09 03:30:21 +02:00 committed by GitHub
parent 6bfd3d42e9
commit 796fbf5eb1
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,9 +1,3 @@
>
>
> ## Caution README in progress
>
>
# frontexpress
Minimalist front end router framework a la [express](http://expressjs.com/)
@ -34,13 +28,13 @@ $ npm install frontexpress
## Quick Start
The quickest way to get started with frontexpress is to clone [frontexpress sample](https://github.com/camelaissani/frontexpress) to generate an application as shown below:
The quickest way to get started with frontexpress is to clone [frontexpress-demo](https://github.com/camelaissani/frontexpress-demo) to generate an application as shown below:
Clone the git repository:
```bash
$ git clone git@github.com:camelaissani/frontexpress-sample.git
$ cd frontexpress-sample
$ git clone git@github.com:camelaissani/frontexpress-demo.git
$ cd frontexpress-demo
```
Install dependencies:
@ -71,6 +65,17 @@ $ npm install
$ npm test
```
## Disclaimer
>
> In this first version of frontexpress, the API is not completely the miror of the expressjs one.
>
> There are some missing methods. Currently, the use, get, post... methods having a middlewares array as parameter are not available.
> The string pattern to define route paths is not yet implemented.
>
> Obviously, the objective is to have the same API as expressjs when the methods make sense browser side.
>
## Routing
### Basic routing