Skip to content

Commit b948ac2

Browse files
RadioAndreaRadioAndrea
committed
Merge branch 'master' into container-build-fixes
2 parents 3a03bf0 + e3b448b commit b948ac2

File tree

1 file changed

+46
-44
lines changed

1 file changed

+46
-44
lines changed

‎README.md

Lines changed: 46 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
11
# 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)
22

3-
![the Parrot is not dead](https://user-images.githubusercontent.com/60719165/226138056-a2b1076c-fd4c-4488-b330-55e57f9ecc78.png)
3+
<img src="https://user-images.githubusercontent.com/60719165/226138056-a2b1076c-fd4c-4488-b330-55e57f9ecc78.png" alt="the Parrot is not dead" width="300" height="300">
4+
45

56
Welcome to the FreeTakServer (FTS) git repository.
67

78
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.
8-
It's free and open source (released under the [Eclipse Public License](https://www.eclipse.org/legal/epl-2.0/).
9-
10-
## User Documentation
9+
It's free and open source (released under the [Eclipse Public License](https://www.eclipse.org/legal/epl-2.0/)).
10+
11+
- [Use Cases](#use-cases)
12+
- [Documentation](#documentation)
13+
- [Requirements](#requirements)
14+
- [Community](#community)
15+
- [Project Status](#project-status)
16+
- [Public instance](#public-instance)
17+
- [Tell us what you think](#tell-us-what-you-think)
18+
- [Project Structure](#project-structure)
19+
- [Architecture](#architecture)
20+
- [Donate](#donate)
21+
- [Open Source Notes](#open-source-notes)
1122

1223
![FTS UI 1.8](https://user-images.githubusercontent.com/60719165/118400921-0731e180-b63a-11eb-976e-c38ee052a013.png)
1324

14-
For documentation on installation and usage visit our [FreeTAKServer Documentation page](https://freetakteam.github.io/FreeTAKServer-User-Docs/)
15-
1625
## Use Cases
1726

1827
FTS allows you to connect ATAK clients to share geo information, to chat with all the connected clients, exchange files and more.
@@ -27,9 +36,33 @@ It intends to support all the major use cases of the original TAK server.
2736
- SSL Encryption
2837
- KML generation
2938
- Command Line Interface
30-
- [Extensive REST API](https://freetakteam.github.io/FreeTAKServer-User-Docs/API/REST_APIDoc/) for integrations and extensions
39+
- [Extensive REST API](https://freetakteam.github.io/FreeTAKServer-User-Docs/API/REST_API_Doc/) for integrations and extensions
40+
![some use cases](https://user-images.githubusercontent.com/60719165/193834333-ea041722-e3ea-46f9-9eb6-7417c19807ea.png)
41+
42+
## Documentation
43+
44+
For documentation on installation and usage visit our [FreeTAKServer Documentation page](https://freetakteam.github.io/FreeTAKServer-User-Docs/)
45+
46+
## Requirements
47+
48+
- Python 3.11
49+
- Dependencies:
50+
- `flask`
51+
- `lxml`
52+
- `pathlib`
53+
- `tabulate`
54+
- `sqlalchemy`
55+
- `setuptools`
56+
- `Flask-SQLAlchemy`
3157

32-
![some use cases](https://github.com/Tapawingo/TAKlib/blob/master/docs/FreeTakServer%20specs/FreeTak%20Use%20Case%20model.png?raw=true)
58+
## Community
59+
60+
If you have any issues don't hesitate to [bring it up](https://github.com/FreeTAKTeam/FreeTakServer/issues), as FreeTAKServer is in continuous development.
61+
To discuss with the ATAK community you may use:
62+
63+
- The [official FreeTakServer Discord](https://discord.gg/VSukyY5wfD)
64+
- The [public ATAK Discord Server](https://discordapp.com/invite/XEPyhHA)
65+
- The [subreddit](https://www.reddit.com/r/ATAK/)
3366

3467
## Project Status
3568

@@ -41,7 +74,7 @@ Also subscribe to this feed to be automatically informed about PIP new versions:
4174
### Public instance
4275

4376
We support a public instance of FTS.
44-
the IP address is TCP: 137.184.101.250:8087
77+
the IP address is TCP: `137.184.101.250:8087`
4578

4679
- download the configuration [here](https://drive.google.com/file/d/1IK1LfPN13EWikHaMyOuDDwIerNGz-Wli/view?usp=sharing)
4780
- use the Import manager in ATAK to import the configuration
@@ -51,51 +84,19 @@ the IP address is TCP: 137.184.101.250:8087
5184

5285
To discuss with the developer team:
5386

54-
- Visit the ATAK subreddit
55-
<https://www.reddit.com/r/ATAK/>
56-
- or join the ATAK Discord
57-
<https://discordapp.com/invite/XEPyhHA>
58-
- or join the FreeTakServer Discord
87+
- Join the FreeTakServer Discord
5988
<https://discord.gg/VSukyY5wfD>
6089

61-
## Architecture
62-
63-
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.
64-
65-
## Documentation
66-
67-
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.
68-
69-
## Requirements
70-
71-
- Python 3.11
72-
- Dependencies:
73-
- `flask`
74-
- `lxml`
75-
- `pathlib`
76-
- `tabulate`
77-
- `sqlalchemy`
78-
- `setuptools`
79-
- `Flask-SQLAlchemy`
80-
81-
## Installing and using FreeTakServer
82-
83-
For installation [go here](https://freetakteam.github.io/FreeTAKServer-User-Docs/Installation/Linux/1_Install/).
84-
8590
## Project Structure
8691

8792
- [FreeTakServer](./FreeTAKServer/)
8893
- **Controllers**: Contains FTS business Logic
8994
- **Models**: Contains all the FTS object model
9095
- **Views**: contains the access to FTS
9196

92-
## Community
93-
94-
If you have any issues don't hesitate to [bring it up](https://github.com/Tapawingo/FreeTakServer/issues), as FreeTAKServer is in continuous development.
95-
To discuss with the developer team you may use:
97+
## Architecture
9698

97-
- The [subreddit](https://www.reddit.com/r/ATAK/)
98-
- The [public ATAK Discord Server](https://discordapp.com/invite/XEPyhHA)
99+
TAKFreeServer uses a MVC pattern, the concept of a [COT (Cursor On Target)](https://freetakteam.github.io/FreeTAKServer-User-Docs/About/architecture/cot_domain/) is described in a set of Domain classes, generated from the UML model using a Model Driven Architecture approach.
99100

100101
## Donate
101102

@@ -135,3 +136,4 @@ We'd like to thank the following individuals and organizations for providing cru
135136
- [Bootstrap4](https://getbootstrap.com/)
136137
- [pyopenssl](https://pypi.org/project/pyOpenSSL/)
137138
- [Flask Dashboard Black by AppSeed](https://github.com/app-generator/flask-black-dashboard)
139+

0 commit comments

Comments
 (0)