Skip to content

Latest commit

 

History

History
99 lines (65 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

99 lines (65 loc) · 2.95 KB
Raw

Developer Contributing Guide

This guide is for developers who want to contribute to the project.

Development Environment

To develop Artalk, including the frontend and backend, you need to install the following tools:

Then we'll setup the development environment.

Get the source code

Run the following command to clone the repository:

git clone https://github.com/ArtalkJS/Artalk

It is recommended to fork the repository first, and then clone the forked repository.

Enter the directory:

cd Artalk

Build frontend and backend

First, we need to install the dependencies for backend written in Go. Simply run the following command:

make build-debug

This will build both the frontend and backend, with debugging symbols.

  • Frontend will be built under ./ui/packages/artalk and copied to ./public directory.
  • Backend will be built under ./bin directory.

Optional: Use one-key script to run a demo site

If you want to run a demo site, you can use the following command:

./scripts/setup-example-site.sh

This script sets up a local example site for testing at local folder, with Artalk integrated into its theme.

After running this script, run:

./bin/artalk server -c ./local/local.yml

to start the artalk server.

And open http://localhost:1313/ in your browser to view the example site.

Here is the default admin account (only created in test mode):

name: "admin"
email: "[email protected]"
password: "admin"

Project Structure

Artalk is a monorepo project, which means all the source code is in the same repository. However, the frontend and backend are separated. The frontend part is located in ./ui directory.

  • bin/ - The compiled binary files. This directory is ignored by git.
  • cmd/ - The source code for the command line tools.
  • conf/ - The sample configuration files.
  • docs/ - The documentation site source code.
  • i18n/ - The translation files.
  • internal/ - The internal packages.
  • local/ - The local example site. This directory is ignored by git.
  • public/ - The static files. Built frontend files will be copied here.
  • scripts/ - The scripts for development.
  • server/ - The source code for the server.
  • ui/ - The source code for the frontend.

Translation

Artalk aims to be a multilingual project. If you would like to contribute to the translation, here are some tips:

If you just write some new features or do some fixes/refactoring, use the following command to generate the translation template

go run ./internal/i18n/gen -w . -d .

If you're not a programmer and would like to help us improve the translation, you can edit the translation files directly in the `.i18n' directory and then submit a pull request.