Skip to content

Commit 2607d32

Browse files
flatfisherflatfisher
committed
Initial commit
0 parents  commit 2607d32

15 files changed

+2368
-0
lines changed

‎.gcloudignore

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# This file specifies files that are *not* uploaded to Google Cloud Platform
2+
# using gcloud. It follows the same syntax as .gitignore, with the addition of
3+
# "#!include" directives (which insert the entries of the given .gitignore-style
4+
# file at that point).
5+
#
6+
# For more information, run:
7+
# $ gcloud topic gcloudignore
8+
#
9+
.gcloudignore
10+
# If you would like to upload your .git directory, .gitignore file or files
11+
# from your .gitignore file, remove the corresponding line
12+
# below:
13+
.git
14+
.gitignore
15+
.DS_Store
16+
.vscode
17+
18+
node_modules

‎.gitignore

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
8+
# Runtime data
9+
pids
10+
*.pid
11+
*.seed
12+
*.pid.lock
13+
14+
# Directory for instrumented libs generated by jscoverage/JSCover
15+
lib-cov
16+
17+
# Coverage directory used by tools like istanbul
18+
coverage
19+
20+
# nyc test coverage
21+
.nyc_output
22+
23+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24+
.grunt
25+
26+
# Bower dependency directory (https://bower.io/)
27+
bower_components
28+
29+
# node-waf configuration
30+
.lock-wscript
31+
32+
# Compiled binary addons (https://nodejs.org/api/addons.html)
33+
build/Release
34+
35+
# Dependency directories
36+
node_modules/
37+
jspm_packages/
38+
39+
# TypeScript v1 declaration files
40+
typings/
41+
42+
# Optional npm cache directory
43+
.npm
44+
45+
# Optional eslint cache
46+
.eslintcache
47+
48+
# Optional REPL history
49+
.node_repl_history
50+
51+
# Output of 'npm pack'
52+
*.tgz
53+
54+
# Yarn Integrity file
55+
.yarn-integrity
56+
57+
# dotenv environment variables file
58+
.env
59+
60+
# next.js build output
61+
.next
62+
63+
functions/*
64+
!functions/.gitkeep

‎CONTRIBUTING-ja.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Contributing to cloud-functions-typescript-template
2+
3+
## Issues
4+
欲しい機能などオススメのconfigなどを作成して提出してください
5+
6+
## Contributing
7+
一般的には、 "fork-and-pull" Gitワークフローに従います。
8+
9+
1. GitHubでリポジトリをフォークする
10+
2. 自分のマシンにプロジェクトをクローンする
11+
3. 自分のブランチへ変更をコミットする
12+
4. 作業内容をフォークしたリポジトリにPushする
13+
5. 変更内容を確認できるようにしプルリクエストを送信します
14+
15+
注意：プルリクエストを行う前に、最新のものを "upstream" からマージするようにしてください

‎CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Contributing to cloud-functions-typescript-template
2+
3+
## Issues
4+
Feel free to submit issues and enhancement requests.
5+
6+
## Contributing
7+
In general, we follow the "fork-and-pull" Git workflow.
8+
9+
1. Fork the repository on GitHub
10+
2. Clone the project to your own machine
11+
3. Commit changes to your own branch
12+
4. Push your work back up to your fork
13+
5. Submit a Pull request so that we can review your changes
14+
15+
NOTE: Be sure to merge the latest from "upstream" before making a pull request!

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 flatfisher
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README-ja.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# cloud-functions-typescript-template
2+
cloud-functions-typescript-templateはTypeScriptを使ったGoogle Cloud Functionsのベースプロジェクトです。このプロジェクトにはよく使いそうなツールや設定ファイル（例: Test toolやLint）が最初から入っています。もしオススメのツールや設定ファイルがあったら気軽にPull RequestやIssueを提出してください。
3+
4+
### Prerequisites
5+
npm, tsc, gcloud コマンドがインストール済
6+
7+
## package.json の configを編集
8+
9+
```
10+
"config": {
11+
"function_name": "関数の名前を定義,　この関数名はindex.tsの export function の名前と一致する必要があります",
12+
"region": "europe-west1 or us-east1 or us-central1 or asia-northeast1",
13+
"gcp_project": "デプロイ先のGCPプロジェクトのIDをいれます"
14+
}
15+
```
16+
17+
## Build
18+
19+
```
20+
$npm run build
21+
```
22+
23+
## Test
24+
25+
```
26+
$npm run test
27+
```
28+
29+
## Deploy
30+
31+
```
32+
$npm run deploy --prefix functions/src/
33+
```

‎README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# cloud-functions-typescript-template
2+
cloud-functions-typescript-template is a base project of Google Cloud Functions using TypeScript. This project contains tools and configuration files that are likely to be used frequently (eg Test tool and Lint) from the beginning. Please feel free to submit Pull Request or Issue if there are recommended tools and configuration files.
3+
4+
### Prerequisites
5+
npm, tsc, gcloud commands installed
6+
7+
## Edit config in package.json
8+
9+
```
10+
"config": {
11+
"function_name": "Your function name, it must match the name of export function in index.ts.",
12+
"region": "europe-west1 or us-east1 or us-central1 or asia-northeast1",
13+
"gcp_project": "Your GCP project name"
14+
}
15+
```
16+
17+
## Build
18+
19+
```
20+
$npm run build
21+
```
22+
23+
## Test
24+
25+
```
26+
$npm run test
27+
```
28+
29+
## Deploy
30+
31+
```
32+
$npm run deploy --prefix functions/src/
33+
```

‎functions/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)