LineTree - Your Family, Your Story

LineTree is a web-based platform for building, editing, viewing, and exporting family trees. It allows you to manage people, relationships, and metadata (dates, places, gender), and exchange data in GEDCOM format.

Table of Contents

• 🌳 Main Features
• 🚀 Getting Started
  • Prerequisites
  • Installation
• 🤝 Contribute to the Project
• 🛠️ Stack

🌳 Main Features

• Family tree creation and editing: Allows you to add, modify, and delete people and family relationships in an intuitive and visual way.
• Interactive display: Dynamic graphical representation of the tree with fluid navigation between ancestors and descendants.
• Standard export and import: Support for common formats such as GEDCOM.
• Secure and private storage: Each user can save their trees in their account with full control over permissions and privacy.

🚀 Getting Started

Prerequisites

To deploy and run the project, you need:

• Docker (version >= 20.10 recommended)
• Docker Compose (version compatible with your Docker)
• .env configuration file with the necessary variables for the application

💡 It is not necessary to install Node.js, MongoDB, or GraphDB on your system, since all services run inside Docker containers.

Installation

1. Clone the repository

git clone https://github.com/elmanueh/linetree.git

2. Enter the project directory

cd linetree

3. Deploy the application with Docker

docker-compose up --build

🤝 Contribute to the project

This repository is Free Software (MIT). Your help is welcome!

If you have any suggestions that could improve the project, please fork the repository and create a pull request. You can also simply open an issue with the "enhancement" tag. Here's a quick guide:

1. Fork the project (https://github.com/elmanueh/linetree/fork)
2. Clone your fork (https://github.com/elmanueh/linetree/fork) (git clone <fork URL>)
3. Add the original repository as a remote (git remote add upstream <original repository URL>)
4. Create your Feature Branch (git switch -c feature/AwesomeFeature)
5. Make your changes (git commit -m 'Add: some AwesomeFeature)
6. Push the branch (git push origin feature/AwesomeFeature)
7. Open a pull request (https://github.com/elmanueh/linetree/pulls)

🛠️ Stack

• - A backend framework for Node.js based on TypeScript and a modular architecture.
• - Statically typed JavaScript.
• - A library for building user interfaces.
• - A rapid build tool for frontend projects.
• - A CSS styling framework with utility classes.