marblejs / docs Goto Github PK
View Code? Open in Web Editor NEWGitBook documentation source code
Home Page: https://docs.marblejs.com
License: MIT License
GitBook documentation source code
Home Page: https://docs.marblejs.com
License: MIT License
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.
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
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);
});
});
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
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.
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?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.