chat-app

README

QUICKCHAT BACKEND

Functional requirements

MVP

1. Users should be able to chat privately with other users
2. Users should be able to create chat groups and add other users by their usernames
3. Users should be able to have profile pictures
4. Users should be able to leave groups
5. Group owners must assign a successor before they can leave a group they own

Extra Features

1. Users should be able to send media
2. There should be end to end encryption
3. Users should be able to post stories

Building from source

1. Make sure you have go installed. You can get it from Go offical site
2. Make sure you have Postgres DB installed. You can get it from Postgres official site
3. Clone the latest changes to your local machine

git clone https://github.com/btdjangbah001/chat-app.git

1. Run

go get

to install dependencies

1. Navigate to /models/setup.go and change database credentials by changing dns variable to

"host=<your_database_domain> password=<your_database_password> dbname=<your_database_name> port=<your_database_port> sslmode=disable"

1. To use a different database you can just change the database driver into whatever you want but note it was built with RDBMS in mind.

2. Run

go run .

to start the application.

1. If you are running it on your local machine you can access the app on

http://localhost:8080

Pro-Tip

To test the app, there's a simple UI in /chat-app-fe/index.html you can use.

License

Copyright © 2023 Bernard Tetteh Djangbah

This project is a free software licensed under GPL v3.0
It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Being Open Source doesn't mean you can just make a copy of the app and host it or sell a closed source copy of the same.

You can ONLY use the source code of this app for `Open Source` Project under `GPL v3.0` or later
with all your source code CLEARLY DISCLOSED on any code hosting platform like GitHub, with clear INSTRUCTIONS on
how to obtain the original software, should clearly STATE ALL CHANGES made and should RETAIN all copyrights.
Use of this software under any "non-free" license is NOT permitted.

Basically the idea behind this project is to give frontend and mobile developers a backend to work with to build their portfolios.