Skip to content

Commit 2c2a410

Browse files
committed
chore: update README for Algora
- Changed links for open and completed bounties to point to the new domain. - Removed unnecessary note about Apple ARM-based chip and Rust compiler. - Updated GitHub app setup instructions for clarity and added new fields for configuration. - Added sections for Stripe and Tigris setup, including environment variable requirements.
1 parent bc42b57 commit 2c2a410

File tree

1 file changed

+46
-13
lines changed

1 file changed

+46
-13
lines changed

README.md

Lines changed: 46 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
</p>
2222

2323
<p align="center">
24-
<a href="https://console.algora.io/org/algora/bounties?status=open">
25-
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2Falgora%2Fbounties%3Fstatus%3Dopen" alt="Open Bounties">
24+
<a href="https://algora.io/org/algora/bounties?status=open">
25+
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Falgora.io%2Fapi%2Fshields%2Falgora%2Fbounties%3Fstatus%3Dopen" alt="Open Bounties">
2626
</a>
27-
<a href="https://console.algora.io/org/algora/bounties?status=completed">
28-
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fconsole.algora.io%2Fapi%2Fshields%2Falgora%2Fbounties%3Fstatus%3Dcompleted" alt="Rewarded Bounties">
27+
<a href="https://algora.io/org/algora/bounties?status=completed">
28+
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Falgora.io%2Fapi%2Fshields%2Falgora%2Fbounties%3Fstatus%3Dcompleted" alt="Rewarded Bounties">
2929
</a>
3030
</p>
3131
</p>
@@ -62,8 +62,6 @@ To get a local copy up and running, follow these steps.
6262
mix deps.get
6363
```
6464

65-
**Note:** If you're using an Apple machine with an ARM-based chip, you need to install the Rust compiler and run `mix compile.rambo`
66-
6765
4. Initialize your `.env` file
6866

6967
```sh
@@ -105,28 +103,63 @@ To get a local copy up and running, follow these steps.
105103
iex -S mix phx.server
106104
```
107105

108-
10. (Optional) Watch for file changes and auto-recompile in a separate terminal
106+
10. (Optional) Watch for file changes and auto reload IEx shell in a separate terminal
109107

110108
```sh
111109
find lib/ | entr mix compile
112110
```
113111

114112
### Setting up external services
115113

116-
Some features of Algora Console rely on external services. If you're not planning on using these features, feel free to skip setting them up.
114+
Some features of Algora rely on external services. If you're not planning on using these features, feel free to skip setting them up.
117115
118116
#### GitHub
119117
120-
GitHub is used for authenticating users.
121-
122-
[Create a GitHub OAuth app](https://github.com/settings/applications/new) and set
118+
[Register new GitHub app](https://github.com/settings/apps/new) and set
123119
124120
- Homepage URL: http://localhost:4000
125-
- Authorization callback URL: http://localhost:4000/callbacks/github/oauth
121+
- Callback URL: http://localhost:4000/callbacks/github/oauth
122+
- Setup URL: http://localhost:4000/callbacks/github/installation
123+
- Redirect on update: Yes
124+
- Webhook URL: https://[your-public-proxy]/webhooks/github (e.g. ngrok, Cloudflare Tunnel)
125+
- Secret: [generate new random string]
126+
- Permissions:
127+
- Read & write issues
128+
- Read & write pull requests
129+
- Read account email address
130+
- Events: issues, pull requests, issue comment, pull request review, pull request review comment
126131
127132
Once you have obtained your client ID and secret, add them to your `.env` file and run `direnv allow .env`
128133
129134
```env
130135
GITHUB_CLIENT_ID=""
131-
GITHUB_CLIENT_SECRET="..."
136+
GITHUB_CLIENT_SECRET=""
137+
GITHUB_APP_HANDLE=""
138+
GITHUB_APP_ID=""
139+
GITHUB_WEBHOOK_SECRET=""
140+
GITHUB_PRIVATE_KEY=""
141+
```
142+
143+
#### Stripe
144+
145+
[Create new Stripe account](https://dashboard.stripe.com/register) to obtain your secrets and add them to your `.env` file.
146+
147+
```env
148+
STRIPE_PUBLISHABLE_KEY=""
149+
STRIPE_SECRET_KEY=""
150+
STRIPE_WEBHOOK_SECRET=""
151+
```
152+
153+
#### Tigris
154+
155+
Tigris is used for hosting static assets.
156+
157+
[Create a public Tigris bucket](https://console.tigris.dev/) to obtain your secrets and add them to your `.env` file.
158+
159+
```env
160+
AWS_ENDPOINT_URL_S3="https://fly.storage.tigris.dev"
161+
AWS_REGION="auto"
162+
AWS_ACCESS_KEY_ID="tid_..."
163+
AWS_SECRET_ACCESS_KEY="tsec_..."
164+
BUCKET_NAME="..."
132165
```

0 commit comments

Comments
 (0)