Bootstruct - GitLite

KO | EN

gitlite — search

#python #android #machine-learning #rust #linux #docker #awesome #cli #kubernetes #vue #ios #mcp #openai #open-source

Bootstruct

(★ 103)

Routing by structure (a Node.js web framework).

파일 탐색기

최종 버전 다운로드 (.zip)

- launch.json
- settings.json
- - ctrl_hooks.md
  - ctrl_proto.md
  - ignore.md
  - io_exit.md
  - io_init.md
  - io_proto.md
  - shared_ctrls.md
  - shared_methods.md
- - after_verb.md
  - get post put delete.md
  - in & out.md
  - index.md
  - no_verb.md
  - pre & post method.md
  - pre & post sub.md
  - use-case.md
  - verbs.md
- Controller Hooks.md
- controller-flowchart.png
- Extending Bootstruct.md
- Get Started.md
- README.md
- - index.js
- play.js
- - hooks.js
  - index.js
- - hooks.js
  - index.js
- - f2j.js
  - for-in.js
  - get-duplicated-keys.js
  - has-own-prop.js
  - index.js
  - is-array.js
  - is-empty.js
  - is-function.js
  - is-string.js
  - log.js
  - normalize-entry-name.js
  - remove-extension.js
  - should-be-ignored.js
  - try-require.js
- constants.js
- debug.js
- errors.js
- io.js
- - creation-errors.spec.js
  - full-use-case.spec.js
  - hooks-1.spec.js
  - hooks-2.spec.js
  - io-params.spec.js
  - method-chain.spec.js
  - parent-chain.spec.js
  - target-chain.spec.js
  - wrappers.spec.js
- bootstruct.spec.js
- make-request.js
.editorconfig
.eslintrc.js
.gitignore
.npmignore
.travis.yml
index.js
LICENSE
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/taitulism/Bootstruct

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd Bootstruct

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Build Status](https://travis-ci.org/taitulism/Bootstruct.svg?branch=master)](https://travis-ci.org/taitulism/Bootstruct)

Bootstruct
==========
Bootstruct is a web framework for Node, based on a folder-structure / file-name convention.

>*Routing by structure.*

Table of contents
-----------------

* Overview (this page)
* [Get Started](https://github.com/taitulism/Bootstruct/blob/master/Docs/Get%20Started.md)
* [Docs](https://github.com/taitulism/Bootstruct/blob/master/Docs/README.md)

Overview
--------
Creating web apps with Node requires wiring up our routes, we need to bind different URL paths to their handlers. We usually do that by declerative coding. Something like: `bind('GET', '/api/books', handler)`.

With Bootstruct you don't code your routes. You just export your handler and name the file with its route name.

Technically, Bootstruct creates routes by parsing your routes folder and routes requests through that folder's structure, matching URLs to corresponding paths under that folder.

Meaning, to support routes like:
```
domain.com/
domain.com/A
domain.com/A/B
domain.com/A/B/C
```

your routes folder tree would generally look like:
```
├── routes
│   ├── index.js
│   └── A
│       ├── index.js
│       └── B
│           ├── index.js
│           └── C
│               └──index.js
```

&nbsp;

Controling Request Flow
-----------------------
When working with middlware functions (`express`, `connect`...) you control request flow by binding 'this' route before 'that' route. The order in which you code your routes matters.

Bootstruct provides you with an onion-like layered app by leveraging the parental folder chain. So a request to `/A/B/C` would go through:
```
1. /
2. /A
3. /A/B
4. /A/B/C
5. /A/B
6. /A
7. /
```
>Do you see the onion?

&nbsp;

Naming Convention
-----------------
Bootstruct uses files and folders with certain names as different hooks.

For example, to handle `GET` requests, name your handler file `_get.js`. To handle `POST` requests, name it `_post.js`.

>**You can create your own hooks**

&nbsp;

What Else?
----------
* Create your own hook
* Handle dynamic url params (e.g. `/A/B/whatever`)
* 
* Extend Bootstruct's different prototypes and more.

&nbsp;

Bootstruct:
-----------
- [x] saves you from coding your routes.
- [x] enforces a natural code separation by concept.
- [x] provides you with great control over request flow.
- [x] is extensible.

&nbsp;

### Start Using Bootstruct
* [Get Started](https://github.com/taitulism/Bootstruct/blob/master/Docs/Get%20Started.md)
* [Docs](https://github.com/taitulism/Bootstruct/blob/master/Docs/README.md)

*******************************************************************************
Questions, suggestions, criticism, bugs, hugs, typos and kudos are all welcome.

*taitu.dev (at) gmail dot com*