• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

TheWillG/github-profile-summary-api: Github Profile Summary API

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

TheWillG/github-profile-summary-api

开源软件地址:

https://github.com/TheWillG/github-profile-summary-api

开源编程语言:

JavaScript 99.3%

开源软件介绍:

GitHub Profile Summary Backend

Powered by https://nodejs.org/, http://expressjs.com/, and https://github.com/hapijs/joi.

The web app is hosted at https://githubprofilesummary.com on Netlify.

This API is hosted on Google App Engine.

Frontend React app for this project is located here: https://github.com/theblindprophet/github-profile-summary.

Install

git clone https://github.com/TheWillG/github-profile-summary-api.git

cd github-profile-summary-api

npm install

Run

npm run start

Testing

npm run test

Tests are located at __tests__

Environment

Name Description Example
PORT Port the app is run on. 3000
LOGGER_LEVEL Logger level configuration used by log4js package info
GITHUB_USERACCESS_TOKEN Access token used to read from the Github API 123456abcdef
MAILGUN_API_KEY Mailgun API Key required to send mail 123456abcdef
MAILGUN_DOMAIN Mailgun Domain name required to send mail subdomain.domain.com
GITHUB_CLIENT_ID GitHub client id xxx
GITHUB_CLIENT_SECRET GitHub client secret xxx
MONGO_URL MongoDB URL xxx

GITHUB_USERACCESS_TOKEN can be obtained here.

The environment variables are encrypted from env to env.enc.

CI/CD

We use Google Cloud Build and Google App Engine for continuous integration and deployment.

File Description
app.yaml Configurations for deployment on Google App Engine
cloudbuild.yaml Configurations for integration testing, non-master branch, on Google Cloud Build
cloudbuild.prod.yaml Configurations for integration testing, master branch, on Google Cloud Build

These files should be NOT edited by anyone except the original maintainers.

Our Google App Engine and Google Cloud Project have also been configured to help with the CI/CD pipeline.

Contributing

We are always willing to accept contributions to this project.

Contributors

Will Garcia (LinkedIn)

Jamie Gross (LinkedIn)




鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap