\r\n\r\n## At a Glance\r\n\r\n`Manifest` is a framework that takes control over Node.js app using a single configuration file. `Manifest` includes `Express` framework and `Handlebars` server-side rendering under the hood.\r\n\r\n## How to Get Started\r\n\r\nType in Terminal:\r\n\r\n```\r\nnpm install --save @imatyushkin/manifest express express-hbs hbs socket.io\r\nnpm install --save-dev @types/express @types/hbs @types/socket.io\r\n```\r\n\r\nor, if you prefer `yarn` over `npm`, type:\r\n\r\n```\r\nyarn add @imatyushkin/manifest express express-hbs hbs socket.io\r\nyarn add @types/express @types/hbs @types/socket.io --dev\r\n```\r\n\r\n## Requirements\r\n\r\n- [express](https://expressjs.com)\r\n- [express-hbs](https://www.npmjs.com/package/express-hbs)\r\n- [hbs](https://www.npmjs.com/package/hbs)\r\n- [socket.io](https://socket.io)\r\n\r\n## Usage\r\n\r\n### Launching App\r\n\r\nThe simplest way to start Express server:\r\n\r\n```typescript\r\nimport * as mfst from \"@imatyushkin/manifest\";\r\n\r\nmfst.App.create().start();\r\n```\r\n\r\nOpen [localhost:3000](http://localhost:3000) in your browser. You will see a message saying `Built with Manifest framework`.\r\n\r\nThat's all! The server is launched 🚀\r\n\r\nFor any personal purposes, you can access `Express` instance by calling\r\n\r\n```typescript\r\napp.expressInstance\r\n```\r\n\r\nQuite simple, right? 😉\r\n\r\n### Server Configuration\r\n\r\nNow let's learn how to configure our server:\r\n\r\n```typescript\r\nimport * as mfst from \"@imatyushkin/manifest\";\r\n\r\nlet app = mfst.App.create({\r\n\tserver: {\r\n\t\tport: 3000,\r\n\t\tsecure: false,\r\n\t\tcorsEnabled: true,\r\n\t\tstaticLocations: []\r\n\t},\r\n\tviewEngines: {\r\n\t\tcurrent: ViewEngine.handlebars\r\n\t},\r\n\tio: {\r\n\t\thandlers: [],\r\n\t\troutes: [\r\n\t\t\t{\r\n\t\t\t\turl: `/`,\r\n\t\t\t\tmethods: {\r\n\t\t\t\t\tget: {\r\n\t\t\t\t\t\ttext: `
`,\r\n\t\t\t\t\t\tstatus: 404,\r\n\t\t\t\t\t\ttimeout: 20000\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t],\r\n\t}\r\n});\r\n\r\napp.start();\r\n```\r\n\r\nIn the above example you can see a very simple configuration that is enough to launch a primitive server which will be able to respond to HTTP requests.\r\n\r\n### Manifest Sections\r\n\r\n#### `server.port`\r\n\r\nPort number that server will be listen to.\r\n\r\n#### `server.secure`\r\n\r\nIf `true`, HTTPS will be used under the hood. Otherwise, we'll use unsecure HTTP.\r\n\r\n#### `server.staticLocations`\r\n\r\nArray of objects. Each object describes an Express static location.\r\n\r\nExample:\r\n\r\n```typescript\r\n{\r\n\tstaticLocations: [\r\n\t\t{\r\n\t\t\talias: `/views`,\r\n\t\t\trealPath: `${__dirname}/frontend`\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\n#### `io.handlers`\r\n\r\nArray of lambda functions. Each function has `request` parameter and handles request before it's processed by `Manifest` framework. You can use handlers for any purpose. For example, sending request information to the console output:\r\n\r\n```typescript\r\nrequestHandlers: [\r\n\t(request) => {\r\n\t\tconsole.log(\"Request:\", `\"${request.url}\"`);\r\n\t}\r\n]\r\n```\r\n\r\n#### `io.routes`\r\n\r\nArray of objects. Each object represents a different route. Example:\r\n\r\n```typescript\r\n{\r\n\troutes: [\r\n\t\t{\r\n\t\t\turl: `/`,\r\n\t\t\tmethods: {\r\n\t\t\t\tget: {\r\n\t\t\t\t\ttext: \"Hello!\"\r\n\t\t\t\t},\r\n\t\t\t\tpost: {\r\n\t\t\t\t\ttext: \"Post response.\"\r\n\t\t\t\t},\r\n\t\t\t\tput: {\r\n\t\t\t\t\ttext: \"Put response.\"\r\n\t\t\t\t},\r\n\t\t\t\tdelete: {\r\n\t\t\t\t\ttext: \"Delete response.\"\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\nThe `methods` object can include any of these HTTP methods:\r\n\r\n- `get`\r\n- `post`\r\n- `put`\r\n- `delete`\r\n\r\nEach HTTP method describes the response to client's request. `Manifest` supports 5 types of response:\r\n\r\n- Text (returns simple text)\r\n- JSON (returns JSON object or array)\r\n- Page (returns page and data for server-side rendering)\r\n- Redirect (sends command for redirection to another URL)\r\n- Custom (arrow function that is implemented by developer and returns text or JSON or page response)\r\n- Custom asynchronous (arrow function that is implemented by developer and returns text or JSON or page response by using callback)\r\n\r\nExample of text response:\r\n\r\n```typescript\r\n{\r\n\troutes: [\r\n\t\t{\r\n\t\t\turl: `/profile`,\r\n\t\t\tmethods: {\r\n\t\t\t\tget: {\r\n\t\t\t\t\ttext: \"
John Green
\"\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\nJSON response:\r\n\r\n```typescript\r\n{\r\n\troutes: [\r\n\t\t{\r\n\t\t\turl: `/profile`,\r\n\t\t\tmethods: {\r\n\t\t\t\tget: {\r\n\t\t\t\t\tjson: {\r\n\t\t\t\t\t\tfirst_name: \"John\",\r\n\t\t\t\t\t\tlast_name: \"Green\"\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\nPage response:\r\n\r\n```typescript\r\n{\r\n\troutes: [\r\n\t\t{\r\n\t\t\turl: `/profile`,\r\n\t\t\tmethods: {\r\n\t\t\t\tget: {\r\n\t\t\t\t\tpath: `${__dirname}/views/profile.hbs`,\r\n\t\t\t\t\tdata: {\r\n\t\t\t\t\t\t// Optional data that will be used by Handlebars engine.\r\n\t\t\t\t\t\tfirstName: \"John\",\r\n\t\t\t\t\t\tlastName: \"Green\"\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\nRedirect response:\r\n\r\n```typescript\r\n{\r\n\troutes: [\r\n\t\t{\r\n\t\t\turl: `/profile`,\r\n\t\t\tmethods: {\r\n\t\t\t\tget: {\r\n\t\t\t\t\tredirectTo: \"/not_found\"\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\nCustom response:\r\n\r\n```typescript\r\n{\r\n\troutes: [\r\n\t\t{\r\n\t\t\turl: `/profile`,\r\n\t\t\tmethods: {\r\n\t\t\t\tget: {\r\n\t\t\t\t\thandler: (request, response) => {\r\n\t\t\t\t\t\tlet firstName = \"John\";\r\n\t\t\t\t\t\tlet lastName = \"Green\";\r\n\r\n\t\t\t\t\t\t// We have to return text or JSON or page response here.\r\n\t\t\t\t\t\treturn {\r\n\t\t\t\t\t\t\tjson: {\r\n\t\t\t\t\t\t\t\tfirst_name: firstName,\r\n\t\t\t\t\t\t\t\tlast_name: lastName\r\n\t\t\t\t\t\t\t}\r\n\t\t\t\t\t\t};\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\nCustom asynchronous response:\r\n\r\n```typescript\r\n{\r\n\troutes: [\r\n\t\t{\r\n\t\t\turl: `/profile`,\r\n\t\t\tmethods: {\r\n\t\t\t\tget: {\r\n\t\t\t\t\tasyncHandler: (request, response, callback) => {\r\n\t\t\t\t\t\tlet firstName = \"John\";\r\n\t\t\t\t\t\tlet lastName = \"Green\";\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t// Return response using callback.\r\n\t\t\t\t\t\tcallback({\r\n\t\t\t\t\t\t\tjson: {\r\n\t\t\t\t\t\t\t\tfirst_name: firstName,\r\n\t\t\t\t\t\t\t\tlast_name: lastName\r\n\t\t\t\t\t\t\t}\r\n\t\t\t\t\t\t});\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\nAlso, most of response types support optional parameters:\r\n\r\n- `status`: HTTP status, by default 200\r\n- `delay`: The duration in milliseconds of delay before returning response.\r\n\r\nExample of using custom HTTP status:\r\n\r\n```typescript\r\n{\r\n\troutes: [\r\n\t\t{\r\n\t\t\turl: `/profile`,\r\n\t\t\tmethods: {\r\n\t\t\t\tget: {\r\n\t\t\t\t\ttext: \"
Not found
\",\r\n\t\t\t\t\tstatus: 404\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\nSometimes you might want to simulate slow server. Use `delay` for this purpose:\r\n\r\n```typescript\r\n{\r\n\troutes: [\r\n\t\t{\r\n\t\t\turl: `/profile`,\r\n\t\t\tmethods: {\r\n\t\t\t\tget: {\r\n\t\t\t\t\tjson: {\r\n\t\t\t\t\t\tfirst_name: \"John\",\r\n\t\t\t\t\t\tlast_name: \"Green\"\r\n\t\t\t\t\t},\r\n\t\t\t\t\tdelay: 4000\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t]\r\n}\r\n```\r\n\r\n#### `server.viewEngines.current`\r\n\r\nThe current view engine. Currently supports `ViewEngine.handlebars` only.\r\n\r\n#### `server.viewEngines.settings.handlebars`\r\n\r\nConfiguration for Handlebars view engine. Includes parameters:\r\n\r\n- `partialsDir`: Path to partials directory.\r\n\r\n## License\r\n\r\n`Manifest` is available under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for more info.\r\n","readmeFilename":"README.md"}
![\"Manifest\"](\"images/logo.png\" "\\"Manifest\\""){kind=logo}
\r\n![](\"https://img.shields.io/badge/Created){kind=icon}
![](\"https://img.shields.io/badge/Written){kind=icon}
![](\"https://img.shields.io/badge/License-Apache){kind=icon}