Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cypress/integration/sampleBlog.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ context('check first integration test', () => {

it('Check if users dont call httprequest', () => {
cy.server();
cy.route('https://jsonplaceholder.typicode.com/users', {
cy.route('http://localhost:8200/users', {
onRequest: req => {
cy.log('Call http done');
expect(true).to.equal(false);
Expand Down
4 changes: 2 additions & 2 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ exports.config = {
};
```

The following is an example that uses the [jsonplaceholder](https://jsonplaceholder.typicode.com/) to fetch a list of
The following is an example that uses the [jsonplaceholder](http://localhost:8200/) to fetch a list of
User IDs for my app. It uses the [JSON Plugin](../scully/routerPlugins/jsonRoutePlugin.ts) which is already part of Scully.

```javascript
Expand All @@ -206,7 +206,7 @@ exports.config = {
'/user/:userId': {
type: 'json',
userId: {
url: 'https://jsonplaceholder.typicode.com/users',
url: 'http://localhost:8200/users',
property: 'id',
},
},
Expand Down
5 changes: 5 additions & 0 deletions docs/scully-cmd-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Scully CLI has the following options available:
- [configFile](#configfile)
- [project](#project)
- [baseFilter](#basefilter)
- [proxyConfig](proxyconfig)
- [removeStaticDist](#removestaticdist)
- [open](#open)
- [ssl](#ssl)
Expand Down Expand Up @@ -64,6 +65,10 @@ npx scully --baseFilter /someRoute

Alias `--bf`. This enable to Scully to start to render an specific route.

## proxyConfig

Alias `--proxy` takes a relative filename filename for a proxy config file. for details look at [this](https://github.com/chimurai/http-proxy-middleware/blob/master/README.md). We use the same config format as [webpackDevServer](https://webpack.js.org/configuration/dev-server/#devserverproxy)

## removeStaticDist

```bash
Expand Down
11 changes: 11 additions & 0 deletions docs/scully-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,18 @@ or teach to the community how to combine scully with others tools.
- [homeFolder](#homefolder)
- [outDir](#outdir)
- [distFolder](#distfolder)
- [proxyConfig](proxyConfig)
- [routes](#routes)
- [handled Routes](#handled-routes)
- [unhandled Routes](#unhandled-routes)
- [extraRoutes](#extraroutes)
- [appPort](#appport)
- [staticport](#staticport)
- [proxyConfig](#proxyconfig)
- [puppeteerLaunchOptions](#puppeteerlaunchoptions)
- [hostName](#hostname)
- [hostUrl](#hosturl)
- [guessParserOptions](#guessparseroptions)

## `ScullyConfig` Interface

Expand Down Expand Up @@ -97,6 +100,10 @@ handled routes reference to routes with dynamic data.
/foo/:id
```

## proxyConfig

Takes a relative filename filename for a proxy config file. for details look at [this](https://github.com/chimurai/http-proxy-middleware/blob/master/README.md). We use the same config format as [webpackDevServer](https://webpack.js.org/configuration/dev-server/#devserverproxy)

`routes` is a reference to all unhandled routes which scully will transform to handled, using plugins.
If you want to know more about plugins go to [Plugins](plugins.md) section.

Expand Down Expand Up @@ -125,6 +132,10 @@ which will serve static files compiled by Scully.

The port by default is: `1668`

### proxyConfig

Optional, when you need a proxy, we can read the proxy config file that is also used by the [Angular CLI](https://angular.io/guide/build#proxying-to-a-backend-server)

### puppeteerLaunchOptions

When in a restricted environment there is a change the default options for puppeteer won't work. In such a case
Expand Down
Loading