https://github.com/zevolution/ponto-menos
The "Puncher"
https://github.com/zevolution/ponto-menos
aws aws-cloudformation aws-lambda cli cron crontab eventbridge eventbridge-scheduler go golang lambda pontomais punchcard punchclock schedule serverless-framework
Last synced: 6 months ago
JSON representation
The "Puncher"
- Host: GitHub
- URL: https://github.com/zevolution/ponto-menos
- Owner: zevolution
- Created: 2023-09-06T20:35:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-17T23:45:20.000Z (over 1 year ago)
- Last Synced: 2025-04-12T19:14:10.899Z (6 months ago)
- Topics: aws, aws-cloudformation, aws-lambda, cli, cron, crontab, eventbridge, eventbridge-scheduler, go, golang, lambda, pontomais, punchcard, punchclock, schedule, serverless-framework
- Language: Go
- Homepage:
- Size: 57.6 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Table of contents
- [About the project](#about-the-project)
- [Description](#description)
- [Built with](#built-with)
- [Installation](#installation)
- [Requirements to run](#requirements-to-run)
- [Modules](#modules)
- [License](#license)
## About the project
This project is a part of my private project portfolio originally implemented in Java. The primary motivation for its migration is to enhance my proficiency with the Go programming language.
## Description
Are you tired of forgetting to clock in or simply are very lazy like me and find it cumbersome to navigate to the clock-in page every time? Stop worrying! The Ponto-Menos app offers a seamless solution for punctuality on [Ponto Mais](https://pontomais.com.br), the brazilian platform responsible for managing employee punch clocks, now under the [VR](https://www.vr.com.br) umbrella. Simplify your workday routine with this user-friendly tool and never miss the "time" again!
## Built with
* [Golang](https://go.dev)
* [Serverless Framework](https://www.serverless.com)
* [Cobra](https://github.com/spf13/cobra)
* [AWS Lambda Go](https://github.com/aws/aws-lambda-go)
* [Zap](https://github.com/uber-go/zap)
* [Viper](https://github.com/spf13/viper)
* [LumberJack](https://github.com/natefinch/lumberjack)
## Installation
To clone and run this application, you'll need Git installed on your computer(or no, if you want to download **.zip**). From your command line:
```bash
# Git CLI
git clone https://github.com/zevolution/ponto-menos.git
# Github CLI
gh repo clone zevolution/ponto-menos
```
## Requirements to run
* If you use Windows OS, is strongly recommended that you use WLS2 to perform all operations.
* [Golang 1.19](https://tip.golang.org/doc/go1.19)
## Build
This project uses Makefile, to view build options using `make help`:
```bash
build Build all binaries
build-cli Build CLI binary (e.g. 'make os=darwin arch=arm64 build-cli' or just 'make build-cli' for linux)
build-lambda Build lambda binaries using param 'name' (e.g. make name=lambda-name build-lambda)
zip-lambda Zip lambda binaries
clean Remove previous build
help Display available commands
```
## Modules
This project features two modules: [Punch-Clock Schedule](cmd/punchclockschedule/README.md) and [CLI](cmd/cli/README.md). For in-depth details about each module, please explore the following links.
## License
[MIT](https://choosealicense.com/licenses/mit/)