Skip to content

Commit ba17196

Browse files
committed
Initial README.md (missing videos)
1 parent abc9cfb commit ba17196

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,36 @@
11
# Rosetta
2+
Rosetta is an Slack bot intended to translate messages in-place on Slack channels. It's name comes from the Rosetta Stone, an ancient artifact that was used to translate hieroglyphics into Greek.
3+
4+
The whole intention of this bot is to be added into the channels of a program that may have come with a influx of non-English speakers, allowing for communication and messages to be sent in languages other than English, while still maintaining the ability to understand the message.
5+
6+
The way it works, it checks on designated channels if a message is using a language other than English, and if it is, it will prompt the person to authorize Rosetta to translate their message to English on their behalf.
7+
8+
## Development
9+
In order to get started with development, you will need to have a Slack app set up and a database set up.
10+
11+
```md
12+
# Clone the repository
13+
$ git clone https://github.com/hackclub/rosetta.git
14+
$ cd rosetta
15+
16+
# Install dependencies
17+
$ bun install
18+
19+
# Create a .env file
20+
$ cp .env.example .env
21+
22+
# Configure the .env file with your OpenRouter API key and Slack bot token
23+
24+
# You can get a Slack bot token from https://api.slack.com/apps
25+
# You can get an OpenRouter API key from https://openrouter.ai/api or get a free AI API by being a Hack Clubber at https://ai.hackclub.com/
26+
27+
# Run the bot
28+
$ bun run src/index.ts
29+
```
30+
31+
## Production
32+
Rosetta was built to be deployed on Coolify, but it should be deployable on any platform that supports Dockerfiles or Bun.
33+
34+
You need to setup a Postgresql database and configure the environment variables in Coolify, same goes with the Slack app and OpenRouter API key.
35+
36+
To deploy Rosetta in Coolify, you can use the following instructions:

0 commit comments

Comments
 (0)