MosesSoftEng / github-auto-commiter-serverles-framework

A cloud project to automatically add commits to a repo file at set interval.

📖 Github Auto Commiter.

Project Description.

A AWS cloud project to automatically add commits to a repo file at set interval using Serverless Framework.

Features lists.

1. Specify repository and file to add commits.
2. Specify information to commit to file.
3. Set interval of commits.

Technologies.

1. AWS Cloud, popular, well documented and affordable. Alternatives: Azure, Google Cloud.
2. Serverless Framework, support micorservices, Infrastructure as Code IaC, and popular. Alternatives: CloudFormation
3. Node.js with TypeScript, versatile, and strongly typed. Alternatives: Python, Go.

💻 More Technologies used.

CloudWatch Events, AWS Lambda and AWS GateWay, Github API.

🏢 Development environment, Tools and IDEs.

Ubuntu 20.04, Visual Studio Code, Github.

Table of Contents.

Project Installation.

1. Clone the project locally.
2. Set up an AWS acoount. and create a user with programmatic access note access credentials.
3. Create a Github access token.
4. Edit project configuration in src/config/config.ts for repository details and schedule interval.
5. Install node locally and AWS CLI.
6. Install Serverless Framework.

# Install serverless framework using node.js
npm install  -g serverless

# Create a serverles project.
sls create --template aws-nodejs-typescript --path .

# Configure serveless to use credentials created in step 1.
sls config credentials --provider aws --key <ACCESS_KEY> --secret <ACCESS_SECREAT> --profile <PROFILE_NAME>

# Export Github access token.
export GITHUB_TOKEN="<ACCESS_TOKEN>"

# Deploy the application.
sls deploy

How to use the project.

The project will run automatically as scheduled. If you want to run the app, make an API call to the endpoints provide after deploying the project.

Credits.

1. Serverless CLI Reference for AWS

License.

See license file

😎 Author.

This project was done by SE. Moses Mwangi. Feel free to get intouch with me;

📱 WhatsApp [phone]

📧 Email [e-mail]

📱 LinkedIn MosesSoftEng