Troplo/Colubrina
1
0
Fork 0
mirror of https://github.com/Troplo/Colubrina.git synced 2024-11-25 12:46:42 +11:00
Code Issues Projects Releases Packages Wiki Activity
Colubrina - a simple open source chat platform written in Vue, Vuetify, NodeJS, and Socket.io.
53 commits 1 branch 31 tags 3.3 MiB
Vue 52.1%
JavaScript 46.5%
CSS 0.8%
HTML 0.6%
Find a file
Troplo a4e71cb412
Merge pull request #2 from Bytedefined/patch-1 
Add unpin message
2022-07-31 20:11:23 +10:00
.github/workflows Create codeql-analysis.yml 2022-07-29 22:06:05 +10:00
backend Add unpin message 2022-07-31 18:10:41 +08:00
cli 1.0.8 2022-07-31 14:56:43 +10:00
frontend 1.0.10 2022-07-31 19:53:52 +10:00
.gitignore update 2022-07-29 20:34:27 +10:00
.prettierignore init 2022-06-05 22:58:18 +10:00
.prettierrc init 2022-06-05 22:58:18 +10:00
colubrina.service update 2022-07-29 20:34:27 +10:00
LICENSE add licenses to root 2022-07-29 21:30:17 +10:00
nginx.conf update 2022-07-29 21:26:18 +10:00
NOTICE add licenses to root 2022-07-29 21:30:17 +10:00
README.md 1.0.9 [Pins & Read Receipts] 2022-07-31 18:42:36 +10:00
SECURITY.md init 2022-06-05 22:58:18 +10:00

README.md

Colubrina

Wakatime

You can try a public instance of Colubrina at colubrina.troplo.com.

This is currently beta software, and may not work as expected. Please file an issue if you encounter any.

Colubrina is a simple self-hostable chatting platform written in Vue, and Vuetify for the frontend, and Node.js, Sequelize and Socket.io for the backend.

Checklist

  • Messaging
  • Authentication
  • Admin panel
  • CLI
  • (partially complete) Scroll up to see more messages/jump to searched message
  • User profile cards
  • Group creation and modification
  • Direct message groups
  • Friending
  • Searching
  • Friend nicknames
  • Embeds & MediaProxy
  • Clean-up/refactor code
  • Mobile responsiveness/compatibility
  • Email verification
  • Password resetting
  • Channel message pins
  • Read receipts

Chat Friends Chat with AMOLED theme Chat with profile card and light theme QuickSwitcher QuickSwitcher with AMOLED theme

Backend setup

First, configure a database and user (MariaDB strongly recommended) for Colubrina.
Please navigate to the backend folder and run yarn.

Then navigate to the cli folder, and run the following commands:

yarn

to install dependencies, and then

node .

which should result in an interactive CLI prompt looking like the following:

Troplo/Colubrina CLI
Colubrina version 1.0.1
Failed to check for updates, ensure you are connected to the internet, and services.troplo.com is whitelisted behind any potential firewalls.
? Please select an option (Use arrow keys)
❯ Setup 
  Create user 
  Run migrations 
  Update/create config file 
  Check for updates 
  Build frontend for production 
  Exit

Select setup, and go through the steps.
After completing the initial setup, you may run yarn build in the frontend folder, or select "Build frontend for production" in the CLI.
The backend service can now be started with node . in the backend folder which will run on port 23998.

A systemd service example config file can be found at colubrina.service, and an nginx.conf example.

Frontend setup

Rename .env.example to .env and fill it out with your own information.

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Lints and fixes files

yarn lint

Customize configuration

See Configuration Reference.

View the Colubrina license in the LICENSE file.