https://github.com/gitx-io/ActionServerless

Use GitHub Actions to create a Serverless service.
https://github.com/gitx-io/ActionServerless

api faas github-actions gitops learn learn-to-code python ruby serverless serverless-framework

Last synced: about 12 hours ago
JSON representation

Use GitHub Actions to create a Serverless service.

• Host: GitHub
• URL: https://github.com/gitx-io/ActionServerless
• Owner: gitfx
• License: apache-2.0
• Created: 2021-03-05T16:10:45.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-27T13:20:27.000Z (7 months ago)
• Last Synced: 2024-10-27T18:21:30.731Z (12 days ago)
• Topics: api, faas, github-actions, gitops, learn, learn-to-code, python, ruby, serverless, serverless-framework
• Language: Python
• Homepage: https://gitfx.github.io/
• Size: 22.5 KB
• Stars: 109
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ActionServerless - Use GitHub Actions to create a serverless service

[![ActionServerless Testing](https://github.com/gitx-io/ActionServerless/workflows/Test%20run%20funcs/badge.svg)](https://github.com/gitx-io/ActionServerless/blob/master/.github/workflows/test_run_funcs.yml)

ActionServerless is an action using [GitFx](https://github.com/gitx-io/GitFx) to do some computing and then generate a string/JSON file to a path, you can visit the file as a service when in dev/testing, or even in your production. We may take it as a GitHub Actions powered `serverless` service.

In fact you can do all of these in native GitHub actions. ActionServerless just wraps the steps to simplify the work:

1. you can focus on coding the real logic, no need to care too much setup steps on the languages that ActionServerless supported(JS/Ruby/Python/Perl etc.). With [a template](https://github.com/gitx-io/ActionServerless-template) we provide, you even don't bother to edit the action workflow configuration.

2. use the route grammer we defined to specify a path to store the generated string/JSON file, that makes the job easy and clear.

## Quick start

At first [use the template](https://github.com/gitx-io/ActionServerless-template/generate) to create a repository. Then We start with a Python example:

```python

# function.py

import json

# GET /api/py_hello.json

print(json.dumps({"hello": "world"}))

```

put the file to a path(default is the root path of a repo, otherwise you need add the path as an argument to your actions configuaration),  when you push the code the action will be triggered. Then the program's output is written to a file located in `api/py_hello.json` that you defined as a route in the comment.

more languages' examples you can find [here](https://github.com/gitx-io/GitFx/tree/master/test/func_examples).

## Languages supported

See: https://github.com/gitx-io/GitFx#languages-supported

## Documents

See: https://github.com/gitx-io/GitFx#documents

## Real world examples

See: https://github.com/gitx-io/GitFx#real-world-examples

## Contributions

Contributions are welcome! You may check the following features in case you'd like to contribute but no idea what to do:

* Support to add your favorite languages

* Support dependency installation to the existing languages

* Use this action to create an application and share it