Skip to content

Latest commit

 

History

History
194 lines (123 loc) · 6.53 KB

README.en.md

File metadata and controls

194 lines (123 loc) · 6.53 KB
Raw

ContributorsForksStargazersIssuesMIT LicenseLinkedIn

Logo

Akinderkkenru

Delivery of poems of Kazakh writers and poets in an understandable language

Read the documentation·Report an error·Suggest a change

Content

  1. About the project
  2. Getting started with the project
  3. Contribute
  4. License
  5. Contacts

About the project

The purpose of this website is to convey the poems of Kazakh writers and poets to the public in an understandable language. This the project is based on the principles of crowdsourcing. People voluntarily contribute poems/annotations to the site.

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

Tools used

  • Express
  • Mongo
  • Bootstrap

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

Getting started with the project

Follow these simple steps to run the project on your computer.

Prerequisites

This project uses the nodejs platform, so please install nodejs yourself. And, this project as a database Uses MongoDB.

  • node

    npm install npm@latest -g

Installation

  1. CloudinaryRegister on the site and get an API key

  2. Copy the repo

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

  3. Install npm packages

    npm install

  4. Environment variables.enventer into the file

     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

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

Contribute

Contributing makes the open-source community an amazing place to learn, be inspired, and come up with new ideas. Any your contributionhighly appreciated.

If you have a suggestion to improve this project, please fork the repository and open a pull request. You You can also go to the "issues" page and submit your suggestions. Don't forget to star the project! Thank you very much!

  1. Fork the project
  2. Open "Feature" (git checkout -b feature/AmazingFeature)
  3. Commit changes (git commit -m 'Add some AmazingFeature')
  4. Push the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

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

License

Distributed under MIT license. For more informationLICENSE.txtopen the file.

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

Contacts

Nurmukhammed -Linkedin

Link to the project:https://github.com/nuromirzak/aqyndar

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