Aqyndar

Қазақстан жазушыларының және ақындарының поэемаларын түсінікті тілде жеткізу

Документацияны оқу · Қате туралы хабарлау · Өзгеріс ұсыну

Мазмұн

1. Проект туралы
   • Қолданылған құралдар
2. Проектке кірісу
   • Алғышарттар
   • Орнату
3. Үлес қосу
4. Лицензия
5. Контакттер

Жоба туралы

Бұл вебсайттың мақсаты - Қазақстан жазушыларының және ақындарының поэемаларын халыққа түсінікті тілде жеткізу. Бұл проект краудсорсинг принциптеріне сүйенеді. Адамдар өз еркі бойынша, сайтқа өлеңдер/аннотациялар қосады.

(жоңарыға көтерілу)

Қолданылған құралдар

• 
• 
• 

(жоңарыға көтерілу)

Проектке кірісу

Проекті өзіңіздің компьютеріңізде іске қосу үшін келесі қарапайым қадамдарды орындаңыз.

Алғышарттар

Бұл жоба nodejs плафтормасын қолданады, сондықтан өзіңізге nodejs орнатыңыз. Және, бұл жоба деректер қоры ретінде MongoDB-ны қолданады.

• node

  npm install npm@latest -g

Орнату

1. Cloudinary сайтына тіркеліп, API кілт алыңыз

2. Репоны көшіріңіз

   git clone https://github.com/nuromirzak/aqyndar.git

3. NPM пакеттерді орнатыңыз

   npm install

4. Қоршаған орта айнымалыларын (environment variables) .env файлына енгізіңіз

    MONGO_DB=# change to your mongodb url
    CLOUDINARY_CLOUD_NAME=# change to your cloudinary cloud name
    CLOUDINARY_KEY=# change to your cloudinary api key
    CLOUDINARY_SECRET=# change to your cloudinary secret

(жоңарыға көтерілу)

Үлес қосу

Үлес қосу - open-source қоғамын үйренуге, шабыттануға, жаға идеялерға арналған таңғажайып орынға айналдырады. Кез келген сіздің үлесіңіз өте жоғары бағаланады.

Егер сізде бұл проектті жақсартатын ұсыныс болса, репозиторийді өзіңізге көшіріп (fork), pull request ашыңыз. Сіз сондай-ақ "issues" бетіне өтіп, өз ұсынысыңзы жіберсеңіз болады. Жобаға жұлдыз беруді ұмытпаңыз! Үлкен рахмет!

1. Проектті өзіңізге көшіріңіз (fork)
2. "Feature" тармағын ашыңыз (git checkout -b feature/AmazingFeature)
3. Өзгерістерді бекітіңіз (git commit -m 'Add some AmazingFeature')
4. Тармаққа push жасаңыз (git push origin feature/AmazingFeature)
5. Pull Request ашыңыз

(жоңарыға көтерілу)

Лицензия

MIT лицензиясы бойынша таратылады. Қосымша ақпарат үшін LICENSE.txt файлын ашыңыз.

(жоңарыға көтерілу)

Контакттер

Nurmukhammed - Linkedin

Жобаға сілтеме: https://github.com/nuromirzak/aqyndar

(жоңарыға көтерілу)