Εισαγωγή

Καλώς ήρθατε στην τεκμηρίωση του Appbox
Με χαρά ανακοινώνουμε ότι το frontend για το Appbox είναι πλέον open-sourced στο GitHub. Στόχος μας είναι να καλλιεργήσουμε μια συνεργατική κοινότητα που συμβάλλει στην τεκμηρίωση, αναπτύσσει νέες frontend λειτουργίες και βοηθά στη βελτίωση της συνολικής εμπειρίας Appbox.

Παρότι η τεκμηρίωσή μας βρίσκεται ακόμη σε πρώιμο στάδιο, εργαζόμαστε για να δημιουργήσουμε έναν ολοκληρωμένο πόρο παρόμοιο με άλλες πλατφόρμες στον χώρο μας. Προς το παρόν, τα docs μας επικεντρώνονται κυρίως στις οδηγίες συνεισφοράς, αλλά σχεδιάζουμε να τα επεκτείνουμε με αναλυτικές πληροφορίες για όλες τις εφαρμογές που είναι διαθέσιμες στο Appbox.

Μέχρι η τεκμηρίωσή μας να γίνει πιο πλήρης, επισκεφθείτε την παλαιότερη knowledge base για άμεσες ερωτήσεις σχετικά με συγκεκριμένες εφαρμογές ή υπηρεσίες. Αν χρειάζεστε τεχνική υποστήριξη, μπορείτε να υποβάλετε ένα ticket για βοήθεια. Μπορείτε πάντα να αποκτήσετε πρόσβαση σε αυτά τα νέα docs μέσω του συνδέσμου στο footer του site μας, για να παρακολουθείτε την πρόοδό μας καθώς τα επεκτείνουμε.

Μελλοντικά σχέδια

• Αναλυτικοί οδηγοί εφαρμογών
  Θα καλύπτουν εγκατάσταση, αντιμετώπιση προβλημάτων και συμβουλές για καθεμία από τις εφαρμογές που υποστηρίζονται στην πλατφόρμα μας.
• Πόροι για χρήστες και developers
  Θα παρέχουν τα πάντα, από tutorials φιλικά προς αρχάριους μέχρι προχωρημένα code references για την προσαρμογή της εμπειρίας σας στο Appbox.
• Περιεχόμενο από την κοινότητα
  Ενθαρρύνουμε pull requests, feedback και προτάσεις — όλα είναι ευπρόσδεκτα και βοηθούν αυτό το project να αναπτυχθεί για όλους.

Ξεκινώντας

Αν θέλετε να δείτε ή να συνεισφέρετε στον open-sourced frontend κώδικά μας, κάντε clone το repository Appbox:

git clone https://github.com/appbox-co/appbox.git

Έπειτα μεταβείτε στο project και εγκαταστήστε τα dependencies του:

cd appbox
pnpm install
pnpm dev

Η τοπική σας εγκατάσταση θα είναι διαθέσιμη στο http://localhost:3000. Μη διστάσετε να εξερευνήσετε, να κάνετε αλλαγές και να δημιουργήσετε pull requests. Εκτιμούμε κάθε συνεισφορά!

Εργαλεία ανάπτυξης

Linting

Το project διαθέτει ολοκληρωμένη ρύθμιση linting με ESLint, TypeScript και ενσωμάτωση Prettier. Αυτό διασφαλίζει συνεπές code style και βοηθά στον έγκαιρο εντοπισμό συνηθισμένων σφαλμάτων. Μπορείτε να εκτελέσετε χειροκίνητα τους linting checks:

# Run linting
pnpm lint
 
# Fix automatically fixable issues
pnpm lint:fix

Η ρύθμιση ESLint περιλαμβάνει:

• Κανόνες ειδικούς για TypeScript μέσω @typescript-eslint
• Linting ειδικό για Next.js με eslint-config-next
• Μορφοποίηση κώδικα με ενσωμάτωση Prettier

Pre-commit Hooks

Χρησιμοποιούμε το Husky για τη διαχείριση Git hooks, κάτι που βοηθά να διασφαλίζεται ότι μόνο ποιοτικός κώδικας γίνεται commit στο repository. Έχουν ρυθμιστεί τα παρακάτω hooks:

• pre-commit: Εκτελεί lint:fix πριν από κάθε commit για να διασφαλίσει την ποιότητα του κώδικα
• commit-msg: Χρησιμοποιεί commitlint για να επιβάλει τη μορφοποίηση conventional commit messages

Αυτό σημαίνει ότι τα commits σας θα ελέγχονται αυτόματα για ποιότητα κώδικα και σωστή μορφοποίηση πριν γίνουν αποδεκτά, διατηρώντας υψηλό επίπεδο σε ολόκληρο το codebase.

Δημιουργία Pull Requests

Όταν είστε έτοιμοι να συνεισφέρετε τις αλλαγές σας, ακολουθήστε αυτές τις οδηγίες για να αυξήσετε την πιθανότητα αποδοχής του Pull Request (PR) σας:

Πριν δημιουργήσετε PR

1. Κάντε rebase από το πιο πρόσφατο main branch για να αποφύγετε merge conflicts:

   git checkout main
   git pull origin main
   git checkout your-branch
   git rebase main

   Copy

2. Βεβαιωθείτε ότι περνάει όλο το linting:

   pnpm lint:fix

   Copy

3. Βεβαιωθείτε ότι ο κώδικάς σας λειτουργεί τοπικά, δοκιμάζοντας τη σχετική λειτουργικότητα.

Οδηγίες PR

1. Κρατήστε τα PRs εστιασμένα - Αντιμετωπίστε ένα issue ή ένα feature ανά PR.
2. Γράψτε σαφή commit messages - Ακολουθώντας τη conventional commit μορφή.
3. Συμπεριλάβετε σαφείς περιγραφές - Εξηγήστε τι κάνει το PR σας και γιατί χρειάζεται.
4. Προσθέστε tests - Όπου ισχύει, προσθέστε tests για να επαληθεύσετε ότι οι αλλαγές σας λειτουργούν σωστά.
5. Τεκμηριώστε τον κώδικά σας - Χρησιμοποιήστε σχόλια για σύνθετη λογική και βεβαιωθείτε ότι τα ονόματα συναρτήσεων είναι περιγραφικά.
6. Ακολουθήστε τα υπάρχοντα μοτίβα - Ο κώδικάς σας πρέπει να ταιριάζει με το style και τα μοτίβα που χρησιμοποιούνται στο υπόλοιπο codebase.

Για σημαντικές αλλαγές, σκεφτείτε να ανοίξετε πρώτα ένα issue για να συζητήσετε την προσέγγιση πριν επενδύσετε χρόνο στον κώδικα. Αυτό βοηθά να διασφαλιστεί ότι η συνεισφορά σας ευθυγραμμίζεται με την κατεύθυνση του project και αποφεύγει άσκοπη προσπάθεια.