marblejs / docs Goto Github PK

The idea is from http://reddit.com/r/typescript/comments/b2hz2r/marblejs_functional_reactive_http_framework_built/eit5agg

So what we could do is to have a section in the docs where each page would be a small example on a specific topic. Some examples could be

• Hello world
• Routing
• Combining routes
• Context
• Authentication

Many code blocks throughout the documentation don't include the import statements needed for the code to work. This means that just to try out some simple "hello world" exercises, I have to dig through the git repo (or elsewhere in the documentation) to figure out where to import things from. Usually it's not too hard, but it really interrupts the flow and gets in the way of learning the tool.

To improve this, I suggest either including the necessary import statements in all examples, or adding a section to the sidebar that lists all the components that can be imported from each package.

We need examples for how to test the endpoints.

For example here is what I did:

// src/server.ts
export const app = createServer({
    port: 3000,
    hostname: '127.0.0.1',
    httpListener,
});

// tests/e2e/health.test.ts
import request from 'supertest';
import {app} from '../../src/server';

describe('/health', () => {
    it('returns 200 OK', () => {
        return request(app.server).get('/health')
            .expect(200);
    });
});

I was using your "hello world" "Getting started" example on https://docs.marblejs.com/overview/getting-started and found some minor things missing in the setup.

I created all files and copied the content from your example.
One described step is to copy the following to the package.json

"scripts": {
  "start": "ts-node index.ts"
}

Maybe you can change it to "start": "ts-node server.ts" as the file is not named index.ts in your example.

For some it might also be helpful to add the line:
yarn add @marblejs/core @marblejs/middleware-logger @marblejs/middleware-body rxjs

Is your feature request related to a problem? Please describe.
There are typos in documentation website and I couldn't find any gh-pages branches or documentation repositories.

Describe the solution you'd like
Please make documentation text available for public contribution :)

Describe alternatives you've considered
Or if it already exists add an edit button with a link to documentation source.

Hi,
sorry for not coming up with a straight pull request containing a solution. I'm just evaluating the framework, and while reading the examples I just noticed that an example responds with the same result regardless ack event had been sent successfully or not. Am I wrong?