Hướng dẫn sử dụng dự án nguồn mở PimpMyStremio

1. Cấu trúc thư mục và giới thiệu dự án

Dự án PimpMyStremio có một số thư mục và file quan trọng như sau:

• docs/: Thư mục chứa các tài liệu hướng dẫn và tài liệu phát triển.
• src/: Thư mục chứa mã nguồn chính của dự án.
• upd/: Thư mục chứa các script và file cập nhật.
• Dockerfile: File để构建 hình ảnh Docker.
• LICENSE: File giấy phép MIT của dự án.
• README.md: File hướng dẫn chính của dự án.

Mỗi thư mục và file có chức năng như sau:

• docs/: Cung cấp hướng dẫn sử dụng và tài liệu cho người dùng và nhà phát triển.
• src/: Là Core của dự án, chứa các module và hàm chính.
• upd/: Chứa các script cập nhật và bảo trì.
• Dockerfile: Cho phép chạy ứng dụng trong môi trường container.
• LICENSE: Xác định điều khoản sử dụng và phân phối.
• README.md: Tóm tắt dự án, cách cài đặt và sử dụng.

2. Giới thiệu về file chạy ứng dụng

Trong thư mục src/, bạn có thể tìm thấy các file chạy ứng dụng như index.js hoặc app.js. Các file này chịu trách nhiệm khởi tạo và chạy ứng dụng. Dưới đây là một ví dụ về nội dung của file khởi động:

// index.js

const http = require('http');

const hostname = 'localhost';
const port = 8080;

const server = http.createServer((req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Xin chào, PimpMyStremio!\n');
});

server.listen(port, hostname, () => {
  console.log(`Máy chủ đang chạy tại http://${hostname}:${port}`);
});

Mã trên tạo một server HTTP đơn giản trả về một thông báo khi truy cập vào đường dẫn gốc.

3. Giới thiệu về file cấu hình

File cấu hình được sử dụng để lưu trữ các tham số có thể thay đổi như thông tin database, port, hoặc các API key. Ví dụ, trong file config.json:

{
  "listenPort": 8080,
  "databaseConnection": {
    "dbHost": "localhost",
    "dbUser": "admin",
    "dbPassword": "admin123",
    "dbName": "mydatabase"
  },
  "apiTokens": {
    "serviceToken": "your_token_here",
    "externalToken": "another_token_here"
  }
}

Trong mã nguồn, bạn có thể đọc các tham số này bằng cách sử dụng module dotenv:

// Cấu hình môi trường
require('dotenv').config();

// Truy cập các biến môi trường
const PORT = process.env.LISTEN_PORT || 8080;
const DB_CONFIG = {
  host: process.env.DB_HOST,
  user: process.env.DB_USER,
  password: process.env.DB_PASSWORD,
  name: process.env.DB_NAME
};
const SERVICE_TOKEN = process.env.SERVICE_TOKEN;

Cách này giúp bạn dễ dàng thay đổi cấu hình mà không cần sửa đổi mã nguồn.