commit f31bc0cd52468d2707c4c92de056c52e694e9ad9 Author: Samuel Pua Date: Sun May 29 00:01:31 2022 +0800 First commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a3bce70 --- /dev/null +++ b/.gitignore @@ -0,0 +1,71 @@ +# Output +/server +/backend/server + +# dotenv +.env + +# ---> Go +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# ---> Vim +# Swap +[._]*.s[a-v][a-z] +!*.svg # comment out if you don't need vector files +[._]*.sw[a-p] +[._]s[a-rt-v][a-z] +[._]ss[a-gi-z] +[._]sw[a-p] + +# Session +Session.vim +Sessionx.vim + +# Temporary +.netrwhist +*~ +# Auto-generated tag files +tags +# Persistent undo +[._]*.un~ + +# ---> VisualStudioCode +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +# ---> Linux +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + diff --git a/README.md b/README.md new file mode 100644 index 0000000..79f0f2b --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Webhook Everythin + +## About +The project's goal is build a generic webhook listener so that webhooks can be received and handled. + +## Deployment +The project uses the following environment variables: + - ENVIRONMENT + - TELEGRAM_API_KEY + - DB_HOST + - DB_PORT + - DB_USER + - DB_PASS + - DB_NAME + - DB_SSL + - HOST_URL + +## Build +The build script is available at `scripts/build.sh`. +`.env` is required to be populated. The example `.env` is available at `.env.example`. + +## Development +The development postgres server can be launched using the script at `scripts/dev_postgres_docker.sh`. \ No newline at end of file