Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add toc, remove duplicate info, restructure README.md #708

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 33 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -7,11 +8,20 @@ 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**
<!---toc start-->

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

For documentation on installation and usage visit our [FreeTAKServer Documentation page](https://freetakteam.github.io/FreeTAKServer-User-Docs/)
* [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)

<!---toc end-->

## Use Cases

Expand All @@ -31,25 +41,30 @@ 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_.
Check out our roadmap [@FreeTakServer#25](https://github.com/FreeTAKTeam/FreeTakServer/issues/25) to see what is planned
Also subscribe to this feed to be automatically informed about PIP new versions:
<https://pypi.org/rss/project/freetakserver/releases.xml>

### 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

### Tell us what you think
- [FreeTakServer](./FreeTAKServer/)
- **Controllers**: Contains FTS business Logic
- **Models**: Contains all the FTS object model
- **Views**: contains the access to FTS

## Community

To discuss with the developer team:
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:

- Visit the ATAK subreddit
<https://www.reddit.com/r/ATAK/>
Expand All @@ -58,44 +73,14 @@ To discuss with the developer team:
- or join the FreeTakServer Discord
<https://discord.gg/VSukyY5wfD>

## 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

Expand Down
Loading