LawKnowledge

Memulai

Prasyarat

Infrastur

• NX - NX adalah satu set alat pengembang yang dapat diperluas untuk monorepos.
• NodeJS - Node.js® adalah runtime JavaScript yang dibangun di atas mesin JavaScript V8 Chrome.
• PNPM - Fast, Disk Space Efficient Package Manager.
• Python - Python adalah bahasa pemrograman yang memungkinkan Anda bekerja dengan cepat dan mengintegrasikan sistem secara lebih efektif.
• Puisi - Puisi membantu Anda mendeklarasikan, mengelola, dan menginstal dependensi proyek Python, memastikan Anda memiliki tumpukan yang tepat di mana -mana.
• Pulumi - Pulumi adalah kelola infrastruktur, rahasia, dan konfigurasi secara intuitif di cloud apa pun.
• Docker (Kubernetes diaktifkan) - Docker adalah platform terbuka untuk mengembangkan, pengiriman, dan menjalankan aplikasi.
• Helm - Helm adalah cara terbaik untuk menemukan, berbagi, dan menggunakan perangkat lunak yang dibangun untuk Kubernetes.

Layanan

• AWS - Akun Layanan Web Amazon diperlukan untuk menggunakan infrastruktur.
• HuggingFace - Akun HuggingFace diperlukan untuk mengunduh dan mengunggah dataset dan model.

? Sumber daya pelukan

Anda dapat mengunduh dataset dari tautan berikut:

• Data Pengetahuan Hukum: Dataset dari Pháp điển dan Văn Bản Pháp Luật.
• Model Pengetahuan Hukum: Model yang disesuaikan dari Phobert.

? ‍ Pengaturan

Pertama, klon repositori ke mesin lokal Anda:

git clone https://github.com/foxminchan/LawKnowledge

Selanjutnya, arahkan ke direktori root proyek dan instal dependensi:

pnpm install --force

Berlari

Untuk situs web, Anda dapat menjalankan perintah berikut:

npx nx serve website --prod

Untuk API, Anda dapat menjalankan perintah berikut:

 # For the API Gateway
npx nx serve api-gateway --prod

# For the Auth Service
npx nx serve auth-svc --prod

# For the Law Service
npx nx serve law-svc --prod

# For the Search Service, navigate to the search-svc directory
npx nx build search-svc && cd apps/api/search-svc/search-svc && python main.py

# For the Chat Service, navigate to the chat-svc directory
npx nx build chat-svc && cd apps/api/chat-svc/chat-svc && python main.py

Untuk melintasi model, Anda dapat menjalankan perintah berikut:

npx nx build bert && cd apps/nlp/bert/bert && python main.py

Untuk mengatur infrastruktur, Anda dapat menjalankan perintah berikut:

npx nx up pulumi

Penting

Jika Anda ingin menjalankan dengan NX, pastikan Anda telah menginstal `puisi` secara global. Versi Python harus `> = 3.9.1 <= 3.12`.

? Pengujian

Untuk situs web, Anda dapat menjalankan perintah berikut:

npx nx test website-e2e

Untuk API, Anda dapat menjalankan perintah berikut:

 # For the Auth Service
npx nx test auth-svc-e2e

# For the Law Service
npx nx test law-svc-e2e

# For the Search Service
npx nx test search-svc-e2e

# For the Chat Service
npx nx test chat-svc

Untuk menguji model, Anda dapat menjalankan perintah berikut:

npx nx test bert

? Lainnya

Untuk menjalankan alat untuk memproses dataset, Anda dapat menjalankan perintah berikut:

npx nx build processor && cd apps/nlp/processor/processor && python main.py

Untuk menjalankan dokumentasi, Anda dapat menjalankan perintah berikut:

npx nx serve docs

Untuk menjalankan diagram sebagai kode, Anda dapat menjalankan perintah berikut:

npx nx build dac && cd assets/dac/dac && python main.py

Beberapa skrip yang berguna:

 # Navigate to the scripts directory
cd tools/scripts && ls

# + scripts
# +-- build.sh --> Build the project
# +-- clean.sh --> Clean the docker image
# +-- init.sh --> Initialize the project
# +-- prepare.sh --> Prepare the project
# +-- start.sh --> Start the project
# +-- start-o11y.sh --> Start the observability stack
# +-- stop-o11y.sh --> Stop the observability stack

# Run the script
./ < script-name >

Grafik ketergantungan

Anda dapat melihat grafik ketergantungan proyek dengan menjalankan perintah berikut:

npx nx dep-graph

Berikut adalah grafik ketergantungan dari proyek:

Berkontribusi

Pedoman yang berkontribusi

Kami sangat senang bahwa Anda tertarik untuk berkontribusi pada proyek ini! Sebelum mengirimkan kontribusi Anda, pastikan untuk meluangkan waktu dan membaca pedoman berikut:

Bacalah pedoman yang berkontribusi kami untuk mempelajari tentang proses pengiriman kami, aturan pengkodean, dan banyak lagi.

? Ingin membantu?

Ingin melaporkan bug, berkontribusi beberapa kode, atau meningkatkan dokumentasi? Bagus sekali! Bacalah pedoman kami untuk berkontribusi dan kemudian periksa salah satu masalah kami yang diberi label sebagai bantuan yang diinginkan atau masalah pertama yang baik .

? Kode Etik

Bantu kami menjaga pengetahuan hukum tetap terbuka dan inklusif. Harap baca dan ikuti kode perilaku kami.

Dukungan dan organisasi

Lisensi

Proyek ini dilisensikan berdasarkan ketentuan lisensi MIT.