perfecty

README

Perfecty Push Server ⚡️

Self-hosted Push Notifications server written in Go.

Send thousands of notifications from your server: No hidden fees, no third party dependencies and you own your data. 👏

NOTICE: This project is under active development and no API is stable yet.

Documentation:

• Design document
• Use cases

Project links:

• Go Server: https://github.com/perfectyorg/perfecty-push
• Javascript SDK: https://github.com/perfectyorg/perfecty-push-js-sdk
• WordPress integration with a built-in Push Server: https://github.com/perfectyorg/perfecty-push-wp
• perfecty.org: https://github.com/perfectyorg/perfecty-push-website
• Documentation site: https://github.com/perfectyorg/perfecty-push-docs

Local Setup 👨🏻‍💻

Generate a sample TLS certificate:

mkdir examples/
openssl req -newkey rsa:2048 -nodes -keyout examples/certs/server.key -x509 -days 365 -out examples/certs/server.crt

# Update the configs:
vi configs/perfecty.yml
  ...
  ssl:
    enabled: true
    cert_file: examples/server.crt
    key_file: examples/server.key

Execute the project:

go run cmd/perfecty/main.go

Generate executable:

go build ./cmd/perfecty/
./perfecty

Configuration 🛠

You can change the values in config/perfecty.yml.

Unit tests 🧪

Run all the tests:

go test -v ./...

License 💡

This project is licensed under MIT.

Contributing

If you're interesting on contributing to this project, feel free to submit your suggestions as a PR or an issue directly to any of the projects repos. Remember to read the Code of Conduct and the license information of each project, which in general use the MIT license, except the WordPress plugin.

Collaborators 🔥

Rowinson Gallego

Special Thanks

Thanks to Jetbrains for supporting this Open Source project with their magnificent tools.

Documentation

Index

• func Start() (err error)

Functions

func Start

func Start() (err error)

Start Start the push server