ashk123 / sunsend

A simple and fast message board

SunSend a simple and fast message board

Notice: it's still in progress

How it works ?

Welcome to the world of Message Boards :-)

There is 2 program for using sunsend:

1. Server Side Program (backend): A program that can provide the chat system written in go (in progress)
2. Client Side program (frontend): A program that can provide a interface for using server side program written in JS (soon)

For sending messages, you need to specify the special channel, each channel has a ID that provram will randomly generate it for,you can find more information in the API documentation (in progress)

This repo is a server side Rest API that provide the chat system, if you wanna just use the chat in your website, you need to see the client repo (in progress) I'm trying to make server clientless, that means you can make a client base on your server for yourself. but if you wanna make your own client you need to know some standard rules, you can find them in the repo (soon)

For more things, you can checkout TODO.md

How does API KEY works?

SunSend server has Client (or you can write one) and for connecting to the server, you need to select your special server

And you wanna sure that just your client can send messages to the your own server, API KEY can provide a authentication process that

You can use on your client and just you (or your website AKA your users) can send message to your SunSend server.

You can generate a api key with cmd/genkey.go and put that to your .env file as _API_KEY variable

for generating api key:

make setup

How to run the server?

For running SunSend you need to do somethings before running it

First of All, you need to generate a api key for your server, you can read more about it on the How Does API Works part

Second, you need to fill your .env file with your own values, notice that that file is a very important file and you must fill it with your own values, variables are:

PORT: your default port for your server
KEY: your API KEY for your sevrer

Thirth, you need to config your server, if you wanna use the default configuration type:

make config

this will install a simple configuration for you

Fourth, you can finnally run your server with command:

make run

Build and run SunSend (soon)