mirror of
https://gitlab.silvrtree.co.uk/martind2000/frontexpress.git
synced 2025-01-12 04:25:08 +00:00
Update README.md
This commit is contained in:
parent
6bfd3d42e9
commit
796fbf5eb1
23
README.md
23
README.md
@ -1,9 +1,3 @@
|
|||||||
>
|
|
||||||
>
|
|
||||||
> ## Caution README in progress
|
|
||||||
>
|
|
||||||
>
|
|
||||||
|
|
||||||
# frontexpress
|
# frontexpress
|
||||||
|
|
||||||
Minimalist front end router framework a la [express](http://expressjs.com/)
|
Minimalist front end router framework a la [express](http://expressjs.com/)
|
||||||
@ -34,13 +28,13 @@ $ npm install frontexpress
|
|||||||
|
|
||||||
## Quick Start
|
## 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:
|
Clone the git repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git clone git@github.com:camelaissani/frontexpress-sample.git
|
$ git clone git@github.com:camelaissani/frontexpress-demo.git
|
||||||
$ cd frontexpress-sample
|
$ cd frontexpress-demo
|
||||||
```
|
```
|
||||||
|
|
||||||
Install dependencies:
|
Install dependencies:
|
||||||
@ -71,6 +65,17 @@ $ npm install
|
|||||||
$ npm test
|
$ 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
|
## Routing
|
||||||
|
|
||||||
### Basic routing
|
### Basic routing
|
||||||
|
Loading…
Reference in New Issue
Block a user