mirego / accent

The first developer-oriented translation tool. True asynchronous flow between translators and your team.
https://www.accent.reviews
BSD 3-Clause "New" or "Revised" License
1.29k stars 97 forks source link

Deployment guide needs an update #381

Open molind opened 1 year ago

molind commented 1 year ago

It's quite straightforward to clone the repository and initiate the docker-compose.yaml file. However, I noticed that there's a lack of information on several fronts. For example, there's no guidance on how to configure an instance, nor is there information about obtaining an API key for accent-cli. Additionally, there's no explanation on how to set up the first user or perform basic maintenance tasks.

I also saw that OpenAI was mentioned in the release logs, but there's no information on how to link an API key to my OpenAI account in order to make use of it.

I hope this information will be useful for enhancing the documentation. Thank you.