teal.fm
1# Contributing
2
3Hi, thanks for showing interest in our project, we appreciate you wanting to be
4a part of it!
5
6> ###### Do you accept external contributions?
7>
8> Yes, we welcome external contributions! The only request we have is that you
9> check with us before working on a large feature, as we'd prefer to avoid duplicating effort.
10>
11> You can do this by either creating an issue that we can communicate through, or
12> popping into the Discord channel and asking in the #development channel.
13> Whatever works best for you!
14>
15> Other than that, feel free to contribute however you'd like!
16
17Fork, then clone the repo:
18
19 git clone git@github.com:your-username/teal.git
20
21Set up your machine:
22
23```bash
24pnpm install && pnpm install -g turbo && cp apps/aqua/.env.example apps/aqua/.env &&
25pnpm run db:migrate
26```
27
28## Development
29
30To start the monorepo run:
31
32```bash
33turbo dev
34```
35
36If you only want to start one service run:
37
38```bash
39turbo dev --filter=<service_path>
40```
41
42Open http://localhost:3000/ with your browser to see the home page. You will need
43to login with Bluesky to test the posting functionality of the app. Note: if the
44redirect back to the app after you login isn't working correctly, you may need to
45replace the `127.0.0.1` with `localhost`.
46
47Push to your fork and [submit a pull request][pr].
48
49[pr]: https://github.com/teal-fm/teal/compare/
50
51Now you're waiting on us! We'll try to comment on the pull request as soon as
52we can!
53
54Thanks again!