FLChat is a messaging app built using Flask for the app, SQLAlchemy for the ORM, and GraphQL for the API
Report Bug
·
Request Feature
FLChat is a messaging app built using Flask for the app, SQLAlchemy for the ORM, and GraphQL for the API. Aside from hobby, this project aimed as author's practice building a robust, maintainable, and reliable backend infrastructure. Author also acknowledge that this project is far from perfect so feedback is much appreciated. Feel free to use, extend, or alter this project to your liking. This is the list of features of the current release:
- To be added..
To get a local copy up and running follow these simple steps.
This is an example of how to list things you need to use the software and how to install them.
- Docker & Docker-compose
or get docker for other platform
sudo apt install docker.io sudo apt install docker-compose
- Clone the repo
git clone https://github.com/github_username/repo_name.git
- Run the app
docker-compose up -d --build
To be added...
Here's the list of things that might be great to do next for this project.
- In depth documentation
- Fix several security issues
- Implement more features (block, history, attachments, etc)
- More testing
- More GraphQL optimization (pagination, rate limiting, introspection, etc)
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.