fit track

Jalur Fit

Fit-Track adalah aplikasi pelacakan log latihan yang dibangun menggunakan tumpukan Mern (MongoDB, Express, React+Vite, Node.js). Dokumentasi ini akan memandu Anda melalui proses berkontribusi pada proyek ini.

Daftar isi

• Instalasi
  • Frontend
  • Backend
• Berkontribusi
  • Forking repositori
  • Mengkloning repositori
  • Membuat cabang
  • Membuat perubahan
  • Melakukan perubahan
  • Mendorong perubahan
  • Membuat Permintaan Tarik
• Lisensi

Instalasi

Frontend

1. Arahkan ke Direktori frontend :

    cd frontend

2. Instal dependensi:

   npm install

3. Mulai server pengembangan:

   npm run dev

Backend

1. Arahkan ke direktori backend :

    cd backend

2. Instal dependensi:

   npm install

3. Pengaturan MongoDB Atlas:

   1. Pergi ke MongoDB Atlas dan buat akun jika Anda belum memilikinya.
   2. Buat cluster baru dengan mengikuti petunjuk. Mongo Atlas Cluster Creation Tutorial
   3. Setelah cluster dibuat, buka bagian akses database dan buat pengguna dengan hak istimewa yang diperlukan.
   4. Pergi ke akses jaringan dan izinkan alamat IP Anda (atau izinkan akses dari mana saja jika menguji secara lokal).
   5. Di bagian Clusters , klik Sambungkan , lalu pilih Hubungkan Aplikasi Anda . Anda akan melihat string koneksi yang terlihat seperti ini:

       mongodb+srv://<username>:<password>@cluster0.mongodb.net/?retryWrites=true&w=majority
      

   6. Ganti <username> dan <password> dengan nama pengguna dan kata sandi MongoDB Atlas Anda yang sebenarnya. Salin seluruh string koneksi.

4. Tambahkan mongoDB atlas_uri ke file .env :

   • Buat file .env di direktori backend .
   • Tambahkan baris berikut ke file .env , ganti <your-mongodb-connection-string> dengan string koneksi yang Anda salin dari mongoDB atlas:

     ATLAS_URI=mongodb+srv:// < username > : < password > @cluster0.mongodb.net/fit-track ? retryWrites=true & w=majority

5. Mulai server:

   node server.js

   atau jika nodemon diinstal untuk pembaruan langsung dari backend:

   nodemon server.js

Struktur proyek

Frontend

Direktori frontend berisi aplikasi React.

• public : Berisi aset publik dari aplikasi.
• src : Berisi kode sumber aplikasi.
  • components : Komponen UI yang dapat digunakan kembali.
    • Home : Komponen Beranda
      • Exercise : Komponen Baris Latihan untuk Menampilkan Durasi, Status, Darinda Saja
      • ExercisesList : Untuk menampilkan daftar latihan yang dilakukan oleh pengguna
      • HeatMap : Didukung oleh apexcharts.js untuk menampilkan rutinitas latihan pengguna
      • Quotes : Dari API Ninja dan menampilkan kutipan secara acak untuk memotivasi pengguna
      • TotalDays : Untuk menampilkan jumlah hari yang dilakukan pengguna
      • UserExperience : Untuk menampilkan pengalaman pengguna dengan pengalaman gamified
      • UserRoutine : Untuk menampilkan rutinitas mingguan pengguna seperti beruntun
    • HomePage : menampilkan dan merender halaman beranda
    • Login : Menampilkan halaman login
    • SignUp : Menampilkan Halaman Pengguna Mendaftar dan Edit
    • navbar : Komponen Navbar
• App.jsx : Komponen utama yang mengatur rute.
• main.jsx : Titik masuk aplikasi React.

Backend

Direktori backend berisi server Node.js dan aplikasi Express.

• models : Berisi skema lumpur.
  • exercise.model : Skema olahraga
  • user.model : skema pengguna
• routes : Berisi rute API.
  • exercises : Rute API Backend untuk Latihan
  • user : rute API backend untuk pengguna
• server.js : Titik masuk aplikasi server.

Berkontribusi

Kami menyambut kontribusi! Untuk berkontribusi pada Fit-Track, ikuti langkah-langkah ini:

Forking repositori

1. Fork Repositori dengan mengklik tombol "Fork" di kanan atas halaman repositori di GitHub.

Mengkloning repositori

2. Klone repositori bercabang Anda ke mesin lokal Anda:

   git clone https://github.com/your-username/Fit-Track.git

3. Arahkan ke Direktori Proyek:

    cd Fit-Track

Membuat cabang

4. Buat cabang baru untuk fitur atau perbaikan bug Anda (buat cabang sesuai dengan masalah yang sedang dikerjakan):

   git switch -c your-branch-name

Membuat perubahan

5. Buat perubahan Anda pada basis kode. Anda dapat mengedit file menggunakan editor kode pilihan Anda.

Melakukan perubahan

6. Tambahkan perubahan pada area pementasan:

   git add .

7. Melakukan perubahan dengan pesan deskriptif:

   git commit -m " Description of your changes "

Mendorong perubahan

8. Dorong perubahan ke repositori bercabang Anda:

   git push origin your-branch-name

Membuat Permintaan Tarik

9. Buat permintaan tarik dari repositori bercabang Anda ke repositori utama. Buka tab "Tarik Permintaan" di repositori utama, dan klik "Permintaan Tarik Baru". Ikuti instruksi untuk membuat permintaan tarik Anda.

Ini baru permulaan! Saya berharap dapat memberikan kontribusi yang lebih bermakna dan berkolaborasi dengan komunitas yang luar biasa ini. Mari kita membangun sesuatu yang hebat bersama dan membuat track yang terbaik bisa saja! ❤️?

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT - lihat file lisensi untuk detailnya.