Bogdan Covrig d6d95024ae Update the installation documentation (#1525 )

* Edited Algolia

* Added Algolia sign-up stepts

* Added sign up Twitter doc

* Changed Twitter info

* Added Twitter and Agolia screenshots

* Added Github and Pusher sections

* Added Github and Pusher sections

2019-01-13 16:03:16 -05:00

7.5 KiB

Raw Blame History

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

Sign in in your Github account.
Fill in the form with and application name, descriptions and URLs http://localhost:3000/. Replace the 3000 port if you run DEV on other port.
You will be redirected in 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
```
You will need a persona token as well. From the same dashboard navigate to Personal access tokens and generate a new token.
Fill in the token description and generate the token.
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
```
Done.

Twitter App

Sign in your Twitter account.
In order to get the API keys you will have to apply for a developer account. Click on Apply buttons.
Setup your Twitter account. Be sure you have your phone number and email address filled in.
Fill in your account information and give a name to your developer account.
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 you want to work on. Copy it, you might use it later ;)
Read :) and accept the Terms and Conditions.
Verify your email address once more and you will be done.
You are done.

Twitter: Get API keys

Sign up or sign in in your Twitter developer account.
From Apps dashboard click on Create and app.
Fill in the app name, description and URL https://dev.to.
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).
Fill in the DEV information, Terms of Service http://dev.to/terms and Privacy policy http://dev.to/privacy.
Write down (or paste) the things that you will work on. Press Create.
Review the Twitter Developer Terms and agree to do nothing sketchy.
The app is all set!
One more change... From the app dashboard go to Permissions and check Request email addresses from users option.

From the same dashboard access the Keys and tokens and change them accordingly (name of Twitter key -> name of our ENV variable):

Access Token -> TWITTER_KEY
Access Token Secret -> TWITTER_SECRET
API key -> TWITTER_ACCESS_TOKEN
API secret key -> TWITTER_ACCESS_TOKEN_SECRET

Done.

Algolia

Go to Algolia singing up page.
Choose one of the three methods of signing up. (email, github or google)
Fill in your information.
Select the datacenter's region.
Fill in or skip the project information.
You are all set up now! You can go to your dashboard.
You can skip the tutorial, we will guide you through the process. Accept the Terms and Conditions.
All good! You can get your API keys now.

Algolia: Get API keys

Sign up or Sign in in your Algolia account.
From your Dashboard click on API Keys.

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

Done.

Pusher

Sign up or sign in in your Pusher account.
Once signed in, fill in the prompt to create a new Pusher Channels app.
In your new Pusher Channels app, click the "App Keys" tab.

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

Done.

7.5 KiB Raw Blame History