Endurain开源项目安装与配置指南

Endurain开源项目安装与配置指南

endurain Endurain is a self-hosted fitness tracking service designed to give users full control over their data and hosting environment 项目地址: https://gitcode.com/gh_mirrors/en/endurain

1. 项目基础介绍

Endurain 是一个自托管的健身追踪服务，旨在给用户完全控制他们的数据和托管环境的能力。它类似于 Strava，但更加注重隐私和定制化。Endurain 允许用户追踪自己的健身活动，同时保持数据的私密性和安全性。

主要编程语言

• 前端：Vue.js、Notivue 和 Bootstrap CSS
• 后端：Python FastAPI
• 数据库：MariaDB 或 PostgreSQL

2. 项目使用的关键技术和框架

• 前端框架：Vue.js，用于构建用户界面。
• 后端框架：FastAPI，一个现代、快速（高性能）的 Web 框架，用于构建 API。
• 数据库：支持 MariaDB 或 PostgreSQL，用于数据存储和管理。
• 其他技术：Alembic（数据库迁移）、SQLAlchemy（ORM）、Strava 和 Garmin Connect 集成、Jaeger（追踪和监控）。

3. 项目安装和配置的准备工作与详细步骤

准备工作

在开始安装之前，请确保您的系统满足以下要求：

• Python 3.7 或更高版本
• Docker
• Docker Compose
• Git

安装步骤

1. 克隆项目

   首先，从 GitHub 克隆 Endurain 仓库到本地环境：

   git clone https://github.com/joaovitoriasilva/endurain.git
   cd endurain
   

2. 设置环境变量

   在项目根目录下创建一个 .env 文件，并添加所需的环境变量。例如：

   DATABASE_URL="mysql://username:password@localhost/endurain"
   STRAVA_CLIENT_ID=your_strava_client_id
   STRAVA_CLIENT_SECRET=your_strava_client_secret
   

   根据您的数据库选择和配置，您需要修改 DATABASE_URL。

3. 构建和运行 Docker 容器

   使用以下命令构建并启动所有需要的 Docker 容器：

   docker-compose up --build
   

4. 初始化数据库

   Endurain 使用 Docker Compose 中的 db 服务来管理数据库。一旦数据库容器启动，您需要运行以下命令来初始化数据库：

   docker-compose run backend alembic upgrade head
   

5. 启动服务

   最后，您可以使用以下命令启动所有服务：

   docker-compose up
   

现在，Endurain 应该已经运行在本地环境中，您可以通过浏览器访问 http://localhost:8080 来查看。

请确保按照项目的官方文档进行任何进一步的配置和定制化。

endurain Endurain is a self-hosted fitness tracking service designed to give users full control over their data and hosting environment 项目地址: https://gitcode.com/gh_mirrors/en/endurain