README
¶
Keystone, the go version
Development environment
.env file
KSAUTH_URL= # url to the auth cloud function
KSAPI_URL= # url to the api cloud function
DATABASE_URL= # postgres url for migrations
Development dependencies
- Google CLoud CLI: Recommended Install
- Cloud SQL Proxy: Intall it from here
- Golang Migrate:
brew install golang-migrate
Development Runtime
Development database access
cloud_sql_proxy \
-dir /tmp/cloudsql \
-instances=wearedevx:europe-west6:devx=tcp:5432 \
-credential_file=functions/ksapi/wearedevx-aa84b56c44de.json
Note : You need a valid gcloud credentials file
Local functions
For the api function
cd functions/ksapi/cmd
go run main.go
For the auth function
cd fucntions/ksapi/cmd
go run main.go
Running the development version
./run.sh [options] [command]
Building the release version
./build.sh
The release binary is ks
Database migration
Generate migrations
./gen.migration.sh create_an_example_table
Creates:
db/migrations/xxxxxx_create_an_example_table.down.shdb/migrations/xxxxxx_create_an_example_table.up.sh
Run migrations
Upward:
./migrate.sh up
Backward:
./migrate.sh down
Specific version:
./migrate.sh force $VERSION
Documentation
¶
Overview ¶
Copyright © 2020 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
module
|
|
|
cli
module
|
|
|
internal
|
|
|
repo
Package repo provides ...
|
Package repo provides ... |
|
utils
From https://samrapdev.com/capturing-sensitive-input-with-editor-in-golang-from-the-cli/
|
From https://samrapdev.com/capturing-sensitive-input-with-editor-in-golang-from-the-cli/ |
|
pkg
|
|
Click to show internal directories.
Click to hide internal directories.