From 5311036924deaf2ed21d20a52cc148a867b53cf5 Mon Sep 17 00:00:00 2001 From: erentar Date: Tue, 30 Apr 2024 22:48:38 +0200 Subject: [PATCH 1/4] add toc, remove duplicate info, restructure README.md --- README.md | 80 +++++++++++++++++++++++-------------------------------- 1 file changed, 33 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index de811cf4..153569f7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# FreeTAKServer [![Downloads](https://pepy.tech/badge/freetakserver)](https://pepy.tech/project/freetakserver) ![PyPI](https://img.shields.io/pypi/v/FreeTAKServer) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/FreeTAKTeam/FreeTakServer) ![Lines of code](https://img.shields.io/tokei/lines/github.com/FreeTAKTeam/FreeTakServer) +# FreeTAKServer +[![Downloads](https://pepy.tech/badge/freetakserver)](https://pepy.tech/project/freetakserver) ![PyPI](https://img.shields.io/pypi/v/FreeTAKServer) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/FreeTAKTeam/FreeTakServer) ![Lines of code](https://img.shields.io/tokei/lines/github.com/FreeTAKTeam/FreeTakServer) ![the Parrot is not dead](https://user-images.githubusercontent.com/60719165/226138056-a2b1076c-fd4c-4488-b330-55e57f9ecc78.png) @@ -7,11 +8,19 @@ Welcome to the FreeTakServer (FTS) git repository. FTS is a Python3 implementation of a TAK Server for devices like [ATAK](https://play.google.com/store/apps/details?id=com.atakmap.app.civ), [WinTAK](https://1drv.ms/u/s!AtMVrrXVTu4YgSanKtSHIslxfRu5?e=ftVio7), and ITAK, it is cross-platform and runs from a multi node installation on AWS down to the Android edition. It's free and open source (released under the [Eclipse Public License](https://www.eclipse.org/legal/epl-2.0/). -## User Documentation +**Table of contents** + -![FTS UI 1.8](https://user-images.githubusercontent.com/60719165/118400921-0731e180-b63a-11eb-976e-c38ee052a013.png) +* [Use Cases](#use-cases) +* [Project Status](#project-status) +* [Documentation](#documentation) + * [Project Structure](#project-structure) +* [Community](#community) + * [Public instance](#public-instance) +* [Donate](#donate) + * [Open Source Notes](#open-source-notes) -For documentation on installation and usage visit our [FreeTAKServer Documentation page](https://freetakteam.github.io/FreeTAKServer-User-Docs/) + ## Use Cases @@ -31,6 +40,8 @@ It intends to support all the major use cases of the original TAK server. ![some use cases](https://github.com/Tapawingo/TAKlib/blob/master/docs/FreeTakServer%20specs/FreeTak%20Use%20Case%20model.png?raw=true) +![FTS UI 1.8](https://user-images.githubusercontent.com/60719165/118400921-0731e180-b63a-11eb-976e-c38ee052a013.png) + ## Project Status This code is currently in _Production Stage_. @@ -38,16 +49,21 @@ Check out our roadmap [@FreeTakServer#25](https://github.com/FreeTAKTeam/FreeTak Also subscribe to this feed to be automatically informed about PIP new versions: -### Public instance +## Documentation -We support a public instance of FTS. -the IP address is TCP: 137.184.101.250:8087 +For installation of FTS, its dependencies, its usage, and information relating to project structure and domain classes, see the [documentation page](https://freetakteam.github.io/FreeTAKServer-User-Docs/) -- download the configuration [here](https://drive.google.com/file/d/1IK1LfPN13EWikHaMyOuDDwIerNGz-Wli/view?usp=sharing) -- use the Import manager in ATAK to import the configuration -- [more details](https://freetakteam.github.io/FreeTAKServer-User-Docs/Usage/Connecting_ATAK/) +### Project Structure + +- [FreeTakServer](./FreeTAKServer/) + - **Controllers**: Contains FTS business Logic + - **Models**: Contains all the FTS object model + - **Views**: contains the access to FTS -### Tell us what you think +## Community + +If you have any issues don't hesitate to [bring it up](https://github.com/Tapawingo/FreeTakServer/issues), as FreeTAKServer is in continuous development. +To discuss with the developer team you may use: To discuss with the developer team: @@ -58,44 +74,14 @@ To discuss with the developer team: - or join the FreeTakServer Discord -## Architecture - -TAKFreeServer uses a MVC pattern, the concept of a COT (Cursor On Target) is described in a set of Domain classes, generated from the UML model using a Model Driven Architecture approach. - -## Documentation - -See [user docs](https://freetakteam.github.io/FreeTAKServer-User-Docs/) for various information including an UML model of the Domain classes involved in a COT event. - -## Requirements - -- Python 3.11 -- Dependencies: - - `flask` - - `lxml` - - `pathlib` - - `tabulate` - - `sqlalchemy` - - `setuptools` - - `Flask-SQLAlchemy` - -## Installing and using FreeTakServer - -For installation [go here](https://freetakteam.github.io/FreeTAKServer-User-Docs/Installation/Linux/1_Install/). - -## Project Structure - -- [FreeTakServer](./FreeTAKServer/) - - **Controllers**: Contains FTS business Logic - - **Models**: Contains all the FTS object model - - **Views**: contains the access to FTS - -## Community +### Public instance -If you have any issues don't hesitate to [bring it up](https://github.com/Tapawingo/FreeTakServer/issues), as FreeTAKServer is in continuous development. -To discuss with the developer team you may use: +We support a public instance of FTS. +the IP address is TCP: 137.184.101.250:8087 -- The [subreddit](https://www.reddit.com/r/ATAK/) -- The [public ATAK Discord Server](https://discordapp.com/invite/XEPyhHA) +- download the configuration [here](https://drive.google.com/file/d/1IK1LfPN13EWikHaMyOuDDwIerNGz-Wli/view?usp=sharing) +- use the Import manager in ATAK to import the configuration +- [more details](https://freetakteam.github.io/FreeTAKServer-User-Docs/Usage/Connecting_ATAK/) ## Donate From cfa087e7e8749f06ef6e6a047478fdad218bbe5b Mon Sep 17 00:00:00 2001 From: erentar Date: Tue, 30 Apr 2024 22:50:47 +0200 Subject: [PATCH 2/4] whoops typo --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 153569f7..d13b32ef 100644 --- a/README.md +++ b/README.md @@ -62,11 +62,9 @@ For installation of FTS, its dependencies, its usage, and information relating t ## Community -If you have any issues don't hesitate to [bring it up](https://github.com/Tapawingo/FreeTakServer/issues), as FreeTAKServer is in continuous development. +If you have any issues don't hesitate to [open an issue](https://github.com/FreeTAKTeam/FreeTakServer/issues), as FreeTAKServer is in continuous development. To discuss with the developer team you may use: -To discuss with the developer team: - - Visit the ATAK subreddit - or join the ATAK Discord From 6c7e371c7cb1ba62c74d817d22776ab10297022c Mon Sep 17 00:00:00 2001 From: erentar Date: Tue, 30 Apr 2024 23:20:58 +0200 Subject: [PATCH 3/4] whoops typo --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d13b32ef..6e7cd4b7 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ It's free and open source (released under the [Eclipse Public License](https://w **Table of contents** + * [Use Cases](#use-cases) * [Project Status](#project-status) * [Documentation](#documentation) @@ -18,7 +19,7 @@ It's free and open source (released under the [Eclipse Public License](https://w * [Community](#community) * [Public instance](#public-instance) * [Donate](#donate) - * [Open Source Notes](#open-source-notes) +* [Open Source Notes](#open-source-notes) @@ -102,7 +103,7 @@ You can also support the project by buying one of our [t-shirts](http://tee.pub/ [![Star History Chart](https://api.star-history.com/svg?repos=FreeTAKTeam/FreeTakServer,tkuester/taky,TAK-Product-Center/Server&type=Date)](https://star-history.com/#FreeTAKTeam/FreeTakServer&tkuester/taky&TAK-Product-Center/Server&Date) -## Open Source Notes +# Open Source Notes FTS was made possible by the following Open Source projects. We'd like to thank the following individuals and organizations for providing crucial support and making FTS possible. From 78ea775716e48e5908e53ef1b760af53ad438cec Mon Sep 17 00:00:00 2001 From: erentar Date: Tue, 30 Apr 2024 23:21:28 +0200 Subject: [PATCH 4/4] whoops typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e7cd4b7..2895bbc4 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ You can also support the project by buying one of our [t-shirts](http://tee.pub/ [![Star History Chart](https://api.star-history.com/svg?repos=FreeTAKTeam/FreeTakServer,tkuester/taky,TAK-Product-Center/Server&type=Date)](https://star-history.com/#FreeTAKTeam/FreeTakServer&tkuester/taky&TAK-Product-Center/Server&Date) -# Open Source Notes +## Open Source Notes FTS was made possible by the following Open Source projects. We'd like to thank the following individuals and organizations for providing crucial support and making FTS possible.