express-boilerplate-generator

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>express-server-generator</title> <meta name="description" content="Documentation for express-server-generator"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">express-server-generator</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="globals.html">Globals</a> </li> </ul> <h1>express-server-generator</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <h1 align="center">welcome to express-server-boilerplate 👋</h1> <p> <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" /> <img alt="Maintenance" src="https://img.shields.io/badge/Maintained-yes-blue.svg" /> <a href="https://github.com/open-devs/express-server-boilerplate/blob/main/LICENSE" target="_blank"> <img alt="Licence" src="https://img.shields.io/badge/License-MIT-blue.svg" /> </a> <a href="https://twitter.com/opendevs_2020" target="_blank"> <img alt="Twitter: opendevs_2020" src="https://img.shields.io/twitter/follow/opendevs_2020.svg?style=social" /> </a> <a href="https://github.com/open-devs" target="_blank"> <img alt="GitHub followers" src="https://img.shields.io/github/followers/open-devs?style=social"> </a> <a href="#" target="_blank"> <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" /> </a> </p> <blockquote> <p>an <em>auth-less</em> <a href="https://expressjs.com/">express</a> server boilerplate to kickstart your backend development.</p> </blockquote> <a href="#🛠-usage" id="🛠-usage" style="color: inherit; text-decoration: none;"> <h2>🛠 usage</h2> </a> <pre><code class="language-sh">$ git <span class="hljs-built_in">clone</span> https://github.com/open-devs/express-server-boilerplate.git $ npm i $ npm run start:dev</code></pre> <a href="#❓-what-is-it" id="❓-what-is-it" style="color: inherit; text-decoration: none;"> <h2>❓ what is it</h2> </a> <p>It is an auth-less express server boilerplate codes to kickstart your backend development.</p> <p>happy backend-deving 😊</p> <a href="#📄-docs" id="📄-docs" style="color: inherit; text-decoration: none;"> <h2>📄 Docs</h2> </a> <p><a href="https://open-devs.github.io/express-server-boilerplate/">express-server-generator</a></p> <a href="#📝-highlight" id="📝-highlight" style="color: inherit; text-decoration: none;"> <h2>📝 highlight</h2> </a> <p>It includes documentation of available routes using swagger. visit <code>localhost:3000\api-docs</code> after localhost setup.</p> <p>happy backend-deving 😊</p> <a href="#🕺-author" id="🕺-author" style="color: inherit; text-decoration: none;"> <h2>🕺 Author</h2> </a> <p><strong>open devs (<a href="mailto:open.devs.github@gmail.com">open.devs.github@gmail.com</a>)</strong></p> <ul> <li>website: <a href="https://opendevs.in/">https://opendevs.in/</a></li> <li>github: <a href="https://github.com/open-devs">@open-devs</a></li> <li>core members: <a href="https://github.com/alok722">@alok722</a>, <a href="https://github.com/mikr13">@mikr13</a></li> </ul> <a href="#🚀-future-scope" id="🚀-future-scope" style="color: inherit; text-decoration: none;"> <h2>🚀 future scope</h2> </a> <ul> <li>adding test-cases</li> <li>more database support (eg: SQL)</li> </ul> <a href="#🤝-contributing" id="🤝-contributing" style="color: inherit; text-decoration: none;"> <h2>🤝 contributing</h2> </a> <p>contributions, issues and feature requests are welcome!<br />feel free to check <a href="">issues page</a>. you can also take a look at the <a href="https://github.com/open-devs/express-server-boilerplate/blob/main/CONTRIBUTING.md">contributing guide</a>.</p> <a href="#🙌-show-your-support" id="🙌-show-your-support" style="color: inherit; text-decoration: none;"> <h2>🙌 show your support</h2> </a> <p>give a ⭐️ if this project helped you!</p> <hr> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="globals.html"><em>Globals</em></a> </li> <li class="label tsd-is-external"> <span>Internals</span> </li> <li class=" tsd-kind-module"> <a href="modules/_src_loadenv_.html">"src/<wbr>Load<wbr>Env"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_src_server_.html">"src/<wbr>Server"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_src_controllers_product_.html">"src/controllers/<wbr>Product"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_src_daos_product_productdao_.html">"src/daos/<wbr>Product/<wbr>Product<wbr>Dao"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_src_daos_index_.html">"src/daos/index"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_src_index_.html">"src/index"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_src_models_index_.html">"src/models/index"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_src_models_product_.html">"src/models/product"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_src_routes_product_.html">"src/routes/<wbr>Product"</a> </li> <li class=" tsd-kind-module"> <a href="modules/_src_routes_index_.html">"src/routes/index"</a> </li> <li class="label tsd-is-external"> <span>Externals</span> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="modules/_src_swagger_.html">"src/swagger"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="assets/js/main.js"></script> </body> </html>