Skip to content

Commit

Permalink
docs: add translation section to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pluveto committed Jan 19, 2023
1 parent bfceff6 commit 891246a
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,17 @@ Then we'll setup the development environment.
Run the following command to clone the repository:

```sh
$ git clone https://github.com/ArtalkJS/Artalk
git clone https://github.com/ArtalkJS/Artalk
```

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

Enter the directory:

```sh
$ cd Artalk
cd Artalk
```


### Build frontend and backend

First, we need to install the dependencies for backend written in Go. Simply run the following command:
Expand All @@ -40,8 +39,8 @@ make debug-build

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.
- **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

Expand All @@ -61,12 +60,24 @@ After running this script, run:

to start the artalk server.

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

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

```
```yaml
name: "admin"
email: "[email protected]"
password: "admin"
```
```
## 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
```sh
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.

0 comments on commit 891246a

Please sign in to comment.