Saya akan hasilkan README.md yang lengkap dan profesional untuk projek Fairbase oleh Sazwanismail. README ini akan merangkumi semua komponen yang telah dibincangkan: BigQuery, MongoDB, React, Node.js, GitHub Actions, dan lain-lain.
# Fairbase
**Fairbase** ialah platform data digital dan cryptocurrency yang menggabungkan analisis data berskala besar dengan BigQuery, storan fleksibel dengan MongoDB, dan antara muka pengguna moden dengan React. Projek ini dibangunkan untuk memudahkan pengurusan aset digital dan data coin dengan automasi penuh melalui GitHub Actions.
---
## π§° Teknologi Utama
| **Bahagian** | **Teknologi** |
|----------------|---------------------------------------------------------------------------------------------------|
| Frontend | React, HTML, CSS, JavaScript |
| Backend | Node.js, Express |
| Database | BigQuery (Google Cloud), MongoDB (Atlas/Self-hosted) |
| DevOps | GitHub Actions, Git, GitHub Pages (dokumentasi) |
| Lain-lain | Python (skrip ETL), Bash/PowerShell (pemasangan .NET) |
---
## π Struktur Direktori
Fairbase/ βββ .github/ β βββ workflows/ # GitHub Actions CI/CD pipelines β βββ deploy-all.yml β βββ data-pipeline.yml βββ BigQuery&DataCoin/ # Skrip berkaitan BigQuery β βββ setup_bigquery.py β βββ load_to_bigquery.py βββ Data&Digital/ # Data mentah dan terproses β βββ raw_data/ β βββ processed/ βββ Python All Language/ # Skrip Python pelbagai guna β βββ setup_mongodb.py β βββ load_to_mongodb.py βββ backend/ # Node.js/Express backend β βββ routes/ β βββ models/ β βββ server.js β βββ package.json βββ codespaces-react/ # React frontend β βββ public/ β βββ src/ β βββ package.json βββ scripts/ # Skrip pembantu (pemasangan, dll.) β βββ dotnet-install.sh β βββ dotnet-install.ps1 βββ docs/ # Dokumentasi tambahan β βββ rare-hounds-behave.md βββ .gitignore βββ LICENSE (Lesen MIT) βββ README.md (Fail ini)
---
## βοΈ Keperluan Sistem
- **Node.js** 18 atau lebih baru
- **Python** 3.10 atau lebih baru
- **Git**
- **Docker** (jika menggunakan devcontainer)
- **Akaun Google Cloud** (dengan BigQuery API diaktifkan)
- **Akaun MongoDB Atlas** (pilihan, jika menggunakan cloud)
---
## π Panduan Persediaan
### 1. Klon Repositori
```bash
git clone https://github.com/Sazwanismail/Fairbase.git
cd Fairbase
cd backend
npm install
cp .env.example .env # Isi pemboleh ubah persekitaran (lihat di bawah)Pemboleh Ubah Persekitaran (.env):
GOOGLE_PROJECT_ID=sazwan-fairbase
GOOGLE_APPLICATION_CREDENTIALS=./path/to/service-account.json
MONGODB_URI=mongodb+srv://username:password@cluster.mongodb.net/fairbase
PORT=5000
cd ../codespaces-react
npm install
cp .env.example .envPemboleh Ubah Persekitaran Frontend:
REACT_APP_API_URL=http://localhost:5000
- Pastikan projek Google Cloud anda aktif dan API BigQuery diaktifkan.
- Muat naik kredential akaun perkhidmatan ke fail yang dirujuk dalam
GOOGLE_APPLICATION_CREDENTIALS. - Jalankan skrip setup:
cd BigQuery&DataCoin pip install -r requirements.txt # Anda perlu buat requirements.txt python setup_bigquery.py
- Sediakan kluster MongoDB (Atlas atau lokal).
- Dapatkan connection string dan masukkan ke
MONGODB_URI. - Jalankan skrip setup:
cd "../Python All Language" pip install pymongo python setup_mongodb.py
Terminal 1 β Backend:
cd backend
npm start
# Server akan berjalan di http://localhost:5000Terminal 2 β Frontend:
cd codespaces-react
npm start
# Aplikasi akan dibuka di http://localhost:3000Jika anda ingin mengisi data contoh ke dalam BigQuery dan MongoDB, jalankan:
python BigQuery&DataCoin/load_to_bigquery.py
python "Python All Language/load_to_mongodb.py"Projek ini menggunakan GitHub Actions untuk automasi:
- Deploy All Components (
.github/workflows/deploy-all.yml): Diaktifkan setiap kali push kemain. Membina frontend dan backend, kemudian deploy ke Firebase Hosting dan Cloud Run (jika dikonfigurasi). - Data Pipeline (
.github/workflows/data-pipeline.yml): Dijadualkan setiap hari jam 2 pagi untuk mengemas kini data di BigQuery dan MongoDB.
Untuk melihat status workflow, pergi ke tab Actions repositori GitHub anda.
Backend menyediakan endpoint berikut:
| Endpoint | Kaedah | Penerangan |
|---|---|---|
/api/health |
GET | Memeriksa kesihatan server |
/api/bigquery/data-coin |
GET | Mendapat data coin dari BigQuery |
/api/bigquery/digital-assets |
GET | Mendapat aset digital dari BigQuery |
/api/mongodb/assets |
GET | Mendapat aset digital dari MongoDB |
/api/mongodb/assets |
POST | Menambah aset digital baru ke MongoDB |
Contoh respons:
[
{
"coin_id": "bitcoin",
"coin_name": "Bitcoin",
"price_usd": 50000.00,
"volume_24h": 1000000,
"market_cap": 1000000000,
"timestamp": "2025-01-01T00:00:00Z"
}
]Projek ini menyertakan konfigurasi Development Container (.devcontainer/devcontainer.json). Ia membolehkan anda menggunakan persekitaran pembangunan yang konsisten dalam VS Code atau GitHub Codespaces.
- Pasang Docker dan Remote - Containers extension dalam VS Code.
- Buka projek, kemudian
Ctrl+Shift+Pβ "Remote-Containers: Reopen in Container". - Tunggu sehingga container siap, dan anda boleh mula membangun tanpa perlu memasang dependensi secara manual.
Kami mengalu-alukan sumbangan daripada komuniti! Sila ikuti langkah berikut:
- Fork repositori ini.
- Buat branch baru (
git checkout -b fitur-anda). - Lakukan perubahan dan commit (
git commit -m 'Tambah fitur X'). - Push ke branch (
git push origin fitur-anda). - Buka Pull Request.
Pastikan anda mengikuti panduan gaya kod dan menulis ujian jika perlu.
Projek ini dilindungi di bawah Lesen MIT. Sila lihat fail LICENSE untuk maklumat lanjut.
- Pengarang: Sazwanismail
- GitHub: @Sazwanismail
- Laman Projek: https://sazwan-fairbase.web.app (jika sudah di-deploy)
Terima kasih kerana menggunakan Fairbase!
**Nota**: Fail README ini anda boleh terus letak di root repositori Fairbase. Jika ada sebarang perubahan atau tambahan yang dikehendaki, sila beritahu.