koa-starter - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #go #golang #android #machine-learning #docker #kubernetes #vue #security #ios #openai

koa-starter

(★ 87)

:koala: A starter kit for a slightly opinionated koa project.

파일 탐색기

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

- - bootstrap-social.css
  - bootstrap.min.css
  - custom.css
  - font-awesome.min.css
- - fa-brands-400.eot
  - fa-brands-400.svg
  - fa-brands-400.ttf
  - fa-brands-400.woff
  - fa-brands-400.woff2
  - fa-solid-900.eot
  - fa-solid-900.svg
  - fa-solid-900.ttf
  - fa-solid-900.woff
  - fa-solid-900.woff2
- - bootstrap.min.js
- favicon.ico
- account.js
- main.js
- handlebars.js
- auth.js
- - main.hbs
- - analytics.hbs
  - navbar.hbs
- account.hbs
- error.hbs
- index.hbs
- login.hbs
.gitignore
config.example.json
eslint.config.cjs
index.js
package-lock.json
package.json
README.md
routes.js

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/snollygolly/koa-starter

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

cd koa-starter

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

2. Node.js

쉬움 추천

사전 준비물

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

npm install

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

npm start

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

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

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# :koala: koa-starter
A starter kit for a slightly opinionated [Koa](http://koajs.com/) project.

## Opinions
I built this Koa starter kit because there's a number of packages I like to use when starting a new project.  The major ones are:

* [Koa v3](http://koajs.com/)
* [Passport](http://passportjs.org/)
* [Handlebars](http://handlebarsjs.com/)
* [Bootstrap v5.3.8](http://getbootstrap.com/)
* [FontAwesome 5.10](https://fortawesome.github.io/Font-Awesome/)

I'm also including goodies from:

* [Nodemon](https://github.com/remy/nodemon)
* [Bootstrap Social](http://lipis.github.io/bootstrap-social/)
* [Github Corners](https://github.com/tholman/github-corners)
* [Google Universal Analytics](https://www.google.com/analytics/)
* [ESLint](http://eslint.org/)
* [Auth0](https://auth0.com/)

## Prerequisites
* [Node.js](https://nodejs.org/en/) (Version 22 and up recommended, async/await support required)
* [Auth0 Account](https://auth0.com/) (for OAuth)

### Installation

* Clone down the repository.
```
git clone https://github.com/snollygolly/koa-starter.git
```

* Install packages (from inside the koa-starter folder).
```
npm install
```

* Create your config.  There's a `config.example.json` file in the root.  Edit it to include all your values for the site and your OAuth information.  Save it as `config.json` and leave it in the root.

* If you want to use Google Analytics, set `config.site.analytics` to your Tracking ID and make sure the analytics partial (analytics.hbs) contains the correct Universal Analytics tracking code.  If you don't want to use Google Analytics, remove that property or set it to false.

* Start it up.
```
npm start
```

* Enjoy!

## Extras

While koa-starter isn't a framework, I've added a few small extras to make getting your project up and started as easy as possible.

#### Including assets from view rendering

When you render you view, you can use the following properties to link to assets.

- Scripts: This array contains scripts living in `/assets/js` that you'd like to link to.  The `.js` will be added for you.

```
await ctx.render("index", {
  title: config.site.name,
  user: user,
  scripts: ["index", "extra"]
});
```

- Vendor JavaScript: This array contains links to external files you'd like to link to.  The `.js` will not be added for you.

```
await ctx.render("index", {
  title: config.site.name,
  user: user,
  vendor_js: ["http://vendor.com/cdn/lib.min.js"]
});
```

- Vendor CSS: This array contains links to external files you'd like to link to.  The `.css` will not be added for you.

```
await ctx.render("index", {
  title: config.site.name,
  user: user,
  vendor_css: ["http://vendor.com/cdn/lib.min.css"]
});
```

#### Error Handling

Thrown errors are caught in the error handling middleware in `index.js`.  By default, all errors will render the `error.hbs` view with information about the error.  It's possible to set `ctx.state.api` equal to `true` in the controller to tell the error handling middleware that this route is an API endpoint, and the error should be sent in JSON instead of rendered as a view.