162 lines
7.5 KiB
Markdown
162 lines
7.5 KiB
Markdown
There are a few services you'll need **_(all free)_** in order to run the development server and access the app locally. Here are the instructions for getting them.
|
|
|
|
# GitHub
|
|
|
|
1. [Sign in](https://github.com/settings/applications/new) in your Github account.
|
|
|
|
2. Fill in the form with an application name, descriptions and URLs `http://localhost:3000/`. Replace the `3000` port if you run DEV on other port.
|
|
|
|
|
|
3. You will be redirected in the app's **Developer settings**. Here you will find the keys. Change them accordingly (name of Github key -> name of our `ENV` variable):
|
|
|
|
```
|
|
Client ID -> GITHUB_KEY
|
|
Client Secret -> GITHUB_SECRET
|
|
```
|
|
|
|
|
|
|
|
4. You will need a personal token as well. From the same dashboard, navigate to **Personal access tokens** and generate a new token.
|
|
|
|
5. Fill in the token description and generate the token.
|
|
|
|
6. Be sure that you copy the token right away, because it is the only time you will see it. Change it accordingly.
|
|
|
|
```
|
|
Personal access tokens -> GITHUB_TOKEN
|
|
```
|
|
|
|
|
|
|
|
7. Done.
|
|
|
|
# Twitter App
|
|
|
|
## Twitter: Sign up
|
|
|
|
1. [Sign in](https://developer.twitter.com/apps) to your Twitter account.
|
|
|
|
2. In order to get the API keys, you will have to apply for a developer account. Click the **Apply** button.
|
|
|
|
|
|
3. Setup your Twitter account. Be sure you have your phone number and email address filled in.
|
|
|
|
|
|
4. Fill in your account information and give a name to your **developer account**.
|
|
|
|
|
|
5. Write down the reasons that you want to use Twitter API. Mention DEV community and describe the issues and tests and things that you want to work on. Copy it, you might use it later ;)
|
|
|
|
|
|
6. Read :) and accept the Terms and Conditions.
|
|
|
|
|
|
7. Verify your email address once more and you will be done.
|
|
|
|
8. You are done.
|
|
|
|
## Twitter: Get API keys
|
|
|
|
1. [Sign up](#twitter-sign-up) or [sign in](https://developer.twitter.com/apps) to your Twitter developer account.
|
|
|
|
2. From **Apps** dashboard, click on **Create and app**.
|
|
|
|
|
|
3. Fill in the app name, description and URL `https://dev.to`.
|
|
|
|
|
|
4. Check the **Enable Sign in with Twitter** option and fill in the Callback URL `http://localhost:3000/users/auth/twitter/callback` (or whatever port you run DEV on).
|
|
|
|
5. Fill in the DEV information, **Terms of Service** `http://dev.to/terms` and **Privacy policy** `http://dev.to/privacy`.
|
|
|
|
|
|
6. Write down (or paste) the things that you will work on. Press **Create**.
|
|
|
|
|
|
7. Review the [Twitter Developer Terms](https://developer.twitter.com/en/developer-terms/agreement-and-policy.html) and agree to do nothing sketchy.
|
|
|
|
|
|
8. The app is all set!
|
|
|
|
9. One more change... From the app dashboard go to **Permissions** and check **Request email addresses from users** option.
|
|
|
|
|
|
10. From the same dashboard access the **Keys and tokens** and change them accordingly (name of Twitter key -> name of our `ENV` variable):
|
|
|
|
```
|
|
API key -> TWITTER_KEY
|
|
API secret key -> TWITTER_SECRET
|
|
Access Token -> TWITTER_ACCESS_TOKEN
|
|
Access Token Secret -> TWITTER_ACCESS_TOKEN_SECRET
|
|
```
|
|
|
|
|
|
|
|
11. Done.
|
|
|
|
# Algolia
|
|
|
|
## Algolia: Sign up
|
|
|
|
1. Go to the Algolia sign up [page](https://www.algolia.com/apps/AJVD3Q9KL3/dashboard).
|
|
|
|
2. Choose one of the three methods of signing up. (email, github or google)
|
|
|
|
3. Fill in your information.
|
|
|
|
|
|
4. Select the datacenter's region.
|
|
|
|
|
|
5. Fill in or skip the project information.
|
|
|
|
|
|
6. You are all set up now! You can go to your dashboard.
|
|
|
|
|
|
7. You can skip the tutorial, we will guide you through the process. Accept the [Terms and Conditions](https://www.algolia.com/policies/terms).
|
|
|
|
|
|
8. All good! You can get your API keys now.
|
|
|
|
## Algolia: Get API keys
|
|
|
|
1. [Sign up](#algolia-sign-up) or [Sign in](https://www.algolia.com/users/sign_in) to your Algolia account.
|
|
|
|
2. From your **Dashboard**, click on **API Keys**.
|
|
|
|
|
|
3. Change your keys accordingly (name of Algolia key -> name of our `ENV` variable):
|
|
|
|
```
|
|
Application ID -> ALGOLIASEARCH_APPLICATION_ID
|
|
Search-Only API Key -> ALGOLIASEARCH_SEARCH_ONLY_KEY
|
|
Admin API KEY -> ALGOLIASEARCH_API_KEY
|
|
```
|
|
|
|
|
|
|
|
4. Done.
|
|
|
|
# Pusher
|
|
|
|
1. [Sign up](https://dashboard.pusher.com/accounts/sign_up) or [sign in](https://dashboard.pusher.com/) to your Pusher account.
|
|
|
|
2. Once signed in, fill in the prompt to create a new Pusher Channels app.
|
|
|
|
|
|
3. In your new Pusher Channels app, click the "App Keys" tab.
|
|
|
|
|
|
4. Change your keys accordingly (name of Pusher key -> name of our application key):
|
|
|
|
```
|
|
app_id -> PUSHER_APP_ID
|
|
key -> PUSHER_KEY
|
|
secret -> PUSHER_SECRET
|
|
cluster -> PUSHER_CLUSTER
|
|
```
|
|
|
|
|
|
|
|
5. Done.
|