|
21 | 21 | </p> |
22 | 22 |
|
23 | 23 | <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"> |
26 | 26 | </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"> |
29 | 29 | </a> |
30 | 30 | </p> |
31 | 31 | </p> |
@@ -62,8 +62,6 @@ To get a local copy up and running, follow these steps. |
62 | 62 | mix deps.get |
63 | 63 | ``` |
64 | 64 |
|
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 | | - |
67 | 65 | 4. Initialize your `.env` file |
68 | 66 |
|
69 | 67 | ```sh |
@@ -105,28 +103,63 @@ To get a local copy up and running, follow these steps. |
105 | 103 | iex -S mix phx.server |
106 | 104 | ``` |
107 | 105 |
|
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 |
109 | 107 |
|
110 | 108 | ```sh |
111 | 109 | find lib/ | entr mix compile |
112 | 110 | ``` |
113 | 111 |
|
114 | 112 | ### Setting up external services |
115 | 113 |
|
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. |
117 | 115 |
|
118 | 116 | #### GitHub |
119 | 117 |
|
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 |
123 | 119 |
|
124 | 120 | - 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 |
126 | 131 |
|
127 | 132 | Once you have obtained your client ID and secret, add them to your `.env` file and run `direnv allow .env` |
128 | 133 |
|
129 | 134 | ```env |
130 | 135 | 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="..." |
132 | 165 | ``` |
0 commit comments