Skip to content

Latest commit

 

History

History
134 lines (99 loc) · 7.67 KB

README.md

File metadata and controls

134 lines (99 loc) · 7.67 KB

Artalk

Artalk

npm version npm downloads Docker Pulls Go Reference Go Report Card CircleCI Codecov npm bundle size

HomepageDocumentationLatest ReleaseChangelog简体中文

Artalk is an intuitive yet feature-rich comment system, ready for immediate deployment into any blog, website, or web application.

  • 🍃 Client ~40KB, crafted with pure Vanilla JS, framework-agnostic
  • 🍱 Server powered by Golang, offering efficient and lightweight cross-platform performance
  • 🐳 One-click deployment via Docker, ensuring ease and speed
  • 🌈 Open-source software, self-hosted with privacy as a priority

Features

Installation

Deploy Artalk Server with Docker in one step:

docker run -d \
    --name artalk \
    -p 8080:23366 \
    -v $(pwd)/data:/data \
    -e "TZ=America/New_York" \
    -e "ATK_LOCALE=en" \
    -e "ATK_SITE_DEFAULT=Artalk Blog" \
    -e "ATK_SITE_URL=https://example.com" \
    artalk/artalk-go

Integrate Artalk Client into your webpage:

Artalk.init({
  el:      '#Comments',
  site:    'Artalk Blog',
  server:  'https://artalk.example.com',
  pageKey: '/2018/10/02/hello-world.html'
})

We offer various installation methods, including binary files, go install, and package managers for Linux distributions.

Learn More →

For Developers

Pull requests are welcome!

See Development and Contributing for information on working with the codebase, getting a local development setup, and contributing changes.

Contributors

Your contributions enrich the open-source community, fostering learning, inspiration, and innovation. We deeply value your involvement. Thank you for being a vital part of our community! 🥰

Supporters

Stargazers repo roster for @ArtalkJS/Artalk

Repobeats Analytics

Alt

Stargazers over time

ArtalkJS%2FArtalk | Trendshift

Stargazers over time

License

MIT

FOSSA Status

FOSSA Status