https://github.com/abdeltwabmf/gomeet
A tool designed to streamline the process of launching meetings
https://github.com/abdeltwabmf/gomeet
go meetings
Last synced: 6 months ago
JSON representation
A tool designed to streamline the process of launching meetings
- Host: GitHub
- URL: https://github.com/abdeltwabmf/gomeet
- Owner: AbdeltwabMF
- License: gpl-3.0
- Created: 2024-03-12T20:14:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-20T17:40:02.000Z (over 1 year ago)
- Last Synced: 2025-03-27T15:47:31.545Z (7 months ago)
- Topics: go, meetings
- Language: Go
- Homepage:
- Size: 11.7 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
gomeet
A meeting reminder and auto-joiner that simplifies meeting management by automatically storing, retrieving, and opening meeting links
## Configuration
Before using `gomeet`, configure it with your details in a valid JSON format. You'll find an example configuration file [config.json](configs/config.json) to get you started.
> [!IMPORTANT]
> The [config.json](configs/config.json) file is placed in the configuration directory of your system:
>
> - Windows: it's `%AppData%\gomeet\` (i.e. `C:\Users\\AppData\Roaming\gomeet\`).
> - Darwin: it's `$HOME/Library/Application Support/gomeet/`.
> - Gnu/Linux: it's `$XDG_CONFIG_HOME/gomeet/`, if non-empty, else `$HOME/.config/gomeet/`.
### Adding calendars
**Local Calendar**: Include your local calendar details in the `"events"` array within [config.json](configs/config.json).
**Google Calendar**:
- [Create a Google Cloud project](https://developers.google.com/workspace/guides/create-project).
- Generate a [credentials.json](configs/credentials.json) file and place it alongside [config.json](configs/config.json) in the gomeet config directory.
> [!IMPORTANT]
> The URL of the event should be placed in **Location** (الموقع الجغرافي) field.
## Build
**Requirements**: [Go programming language](https://go.dev/) (version go1.22.1 or later)
```shell
make build
```
## Usage
### Manual launch
Simply run the built binary to start the program as a background daemon.
```shell
./bin/gomeet.exe &
```
### Startup as Service (Windows only)
1. Open the registry editor (regedit).
2. Navigate to `HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Run`.
3. Create a new String Value named `GoMeet`.
4. Set the `GoMeet` value to the full path of the gomeet executable (e.g., `C:\bin\gomeet.exe`).
For automatic startup on Unix-based systems, refer to your specific distribution's documentation on creating systemd or runit services.
> [!NOTE]
> `gomeet` logs important events (errors, warnings) to a log file for troubleshooting.
>
> - Windows: `%LocalAppData%\gomeet\logs\` or `C:\Users\\AppData\Local\gomeet\logs\`.
> - Darwin: `~/Library/Logs/gomeet/`.
> - Gnu/Linux: `/var/log/gomeet/`
## License
Licensed under the GPL-v3 [License](LICENSE).