Sneed-Group/harmonychat-api-whitepaperish
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update 'README.md'

Browse source
This commit is contained in:
Maxwell Drake 2024-04-04 17:51:38 +00:00
parent 43ab1ab3da
commit 26abc10998
1 changed files with 1 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -1,11 +1,8 @@
# Harmony Chat Backend API Documentation/Whitepaper # Harmony Chat Backend API Documentation/Whitepaper
## UPDATE: HARMONY CHAT IS NOW MAYASPACE V2
## About ## About
Harmony Chat is meant as a simple *discord alternative. Meaning, we are not going to REPLACE discord or replicate it's API, however we will have easay to understand endpoints to make transitioning easy. The API will also be using open technologies such as GUN.js to make our systems decentralized. API server-side will be written using express.js The express.js port will be, by default in the .env.example, 7664, but is changable via .env variable. Servers used as GUN.js distrobution endpoints in the GUN.js initalization will also be in the .env variable. For example, if the array of GUN.js distrobution endpoints is ```['http://localhost:8765/gun', 'https://gun-manhattan.herokuapp.com/gun']``` in the .env (which will be the deafault in .env.example), the running code will be ```let gun = Gun(['http://localhost:8765/gun', 'https://gun-manhattan.herokuapp.com/gun']);``` for starting gun after we require all dependencies* Harmony Chat is meant as a simple *discord alternative. Meaning, we are not going to REPLACE discord or replicate it's API, however we will have easy to understand endpoints to make transitioning easy. The API will also be using open technologies such as GUN.js to make our systems decentralized. API server-side will be written using express.js The express.js port will be, by default in the .env.example, 7664, but is changable via .env variable. Servers used as GUN.js distrobution endpoints in the GUN.js initalization will also be in the .env variable. For example, if the array of GUN.js distrobution endpoints is ```['http://localhost:8765/gun', 'https://gun-manhattan.herokuapp.com/gun']``` in the .env (which will be the deafault in .env.example), the running code will be ```let gun = Gun(['http://localhost:8765/gun', 'https://gun-manhattan.herokuapp.com/gun']);``` for starting gun after we require all dependencies*
## Current BaseURL Example ## Current BaseURL Example