Adjust sample_application.yml and env_checker.rb
This commit is contained in:
Ben Halpern
parent
064efad2ac
commit
937e87918c
3 changed files with 26 additions and 32 deletions
19
README.md
19
README.md
|
|
@ -1,10 +1,10 @@
|
|||
# The DEV Community 👩💻👨💻
|
||||
<center><h1>The DEV Community 👩💻👨💻</h1></center>
|
||||
|
||||
<p align="center">
|
||||
<img
|
||||
alt="DEV"
|
||||
src="https://thepracticaldev.s3.amazonaws.com/i/d3o5l9yiqfv1z24cn1yp.png"
|
||||
height=300px
|
||||
height=200px
|
||||
/>
|
||||
</p>
|
||||
<p align="center">
|
||||
|
|
@ -34,13 +34,11 @@
|
|||
## Introduction and Contribution Guideline
|
||||
Welcome to the [dev.to](https://dev.to) codebase. We are so excited to have you. Most importantly, all contributors must abide by the [code of conduct](https://dev.to/code-of-conduct).
|
||||
|
||||
With your help, we can build out the DEV Community platform to be more stable and better serve the users. The platform is built on [Ruby on Rails](http://rubyonrails.org/). When in doubt, try to do things "The Rails Way", but it is an evolving codebase and we will learn from all new contributions in order to evolve.
|
||||
|
||||
Before we can make the codebase fully open source, we must ensure we discover any possible vulnerabilities that could be exposed by eyes on the code, but in the long run we think that openness can do nothing but help in this way.
|
||||
With your help, we can build out the DEV Community platform to be more stable and better serve the community. We are a [Ruby on Rails](http://rubyonrails.org/). When in doubt, try to do things "The Rails Way", but it is an evolving codebase and we will learn from all new contributions in order to evolve.
|
||||
|
||||
### How to contribute
|
||||
|
||||
When in doubt, ask! We are doing this for the first time and we may not be clear about everything. Creating an issue to ask about how to do something in the open is a great decision. We will try to create clear issues, but communication is the most important thing and it's hard! You may communicate _through_ a pull request. It's a fine approach, but it could result in going down the wrong path. The earlier we talk about something the better.
|
||||
When in doubt, ask! This is a new process and we need to learn from pain points.
|
||||
|
||||
**Refactoring** code, e.g. improving the code without modifying the behavior is an area that can probably be done based on intuition and may not require much communication to be merged.
|
||||
|
||||
|
|
@ -50,15 +48,11 @@ When in doubt, ask! We are doing this for the first time and we may not be clear
|
|||
|
||||
### Clean code with tests
|
||||
|
||||
Even though some of the existing code is poorly written or not tested as well as it could be, we have much more scrutiny for these things going forward, as the transition from team-only development to open development makes clean code more important than ever in order to avoid communication breakdown. Good luck writing the best code of your life!
|
||||
|
||||
### Non-code contributions
|
||||
|
||||
Improving documentation and wikis is very valuable, as is participating in any discussions about approaches or features.
|
||||
Even though some of the existing code is poorly written or untested, we must have more scrutiny for code going forward. We test with [rspec](http://rspec.info/), let us know if you have any questions about this!
|
||||
|
||||
### The bottom line
|
||||
|
||||
If a process could be improved, don't hesitate to bring it up, but there are always tradeoffs and we are humans. Mistakes happen and opinions may not always line up. Shaming anyone trying to contribute is not allowed.
|
||||
We are all humans trying to work together to improve things for the community. Always be kind and appreciate the need for tradeoffs. ❤️
|
||||
|
||||
# Getting Started
|
||||
#### Prerequisite
|
||||
|
|
@ -77,6 +71,7 @@ If a process could be improved, don't hesitate to bring it up, but there are alw
|
|||
- Copy [`config/sample_application.yml`](config/sample_application.yml) in order to create a valid `application.yml`
|
||||
- You'll need to get your own free API keys for a few services in order to get your development environment running. [**Follow this wiki to get them.**](https://github.com/thepracticaldev/dev.to_core/wiki/Getting-API-Keys-for-Basic-Development)
|
||||
- If you are missing `ENV` variables on bootup, `_env_checker.rb` will let you know. If you add or remove `ENV` vars to the project, you must also modify this file before they can be merged. The wiki above should handle all the necessary keys for basic development.
|
||||
- You do not need "real" keys for basic development. Some features require certain keys, so you may be able to add them as you go.
|
||||
5. Run `bin/setup`
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -34,10 +34,6 @@ keys = [
|
|||
"GITHUB_TOKEN",
|
||||
"JWPLAYER_API_KEY",
|
||||
"JWPLAYER_API_SECRET",
|
||||
"KEEN_API_URL",
|
||||
"KEEN_PROJECT_ID",
|
||||
"KEEN_READ_KEY",
|
||||
"KEEN_WRITE_KEY",
|
||||
"MAILCHIMP_API_KEY",
|
||||
"MAILCHIMP_NEWSLETTER_ID",
|
||||
"PERIODIC_EMAIL_DIGEST_MAX",
|
||||
|
|
@ -48,8 +44,6 @@ keys = [
|
|||
"PUSHER_SECRET",
|
||||
"RECAPTCHA_SECRET",
|
||||
"RECAPTCHA_SITE",
|
||||
"SENDBIRD_APP_ID",
|
||||
"SENDBIRD_LIVECHAT_URL",
|
||||
"SERVICE_TIMEOUT",
|
||||
"SHARE_MEOW_BASE_URL",
|
||||
"SHARE_MEOW_SECRET_KEY",
|
||||
|
|
@ -60,6 +54,9 @@ keys = [
|
|||
"STREAM_URL",
|
||||
"STRIPE_PUBLISHABLE_KEY",
|
||||
"STRIPE_SECRET_KEY",
|
||||
"TWILIO_ACCOUNT_SID",
|
||||
"TWILIO_VIDEO_API_KEY",
|
||||
"TWILIO_VIDEO_API_SECRET",
|
||||
"TWITTER_ACCESS_TOKEN",
|
||||
"TWITTER_ACCESS_TOKEN_SECRET",
|
||||
"TWITTER_KEY",
|
||||
|
|
|
|||
|
|
@ -62,8 +62,14 @@ AWS_SDK_SECRET: "REPLACEME"
|
|||
AWS_S3_VIDEO_ID: "REPLACEME"
|
||||
AWS_S3_VIDEO_KEY: "REPLACEME"
|
||||
AWS_S3_INPUT_BUCKET: "REPLACEME"
|
||||
AWS_S3_VIDEO_ID: "REPLACEME"
|
||||
AWS_S3_VIDEO_KEY: "REPLACEME"
|
||||
AWS_SDK_KEY: "REPLACEME"
|
||||
AWS_SDK_SECRET: "REPLACEME"
|
||||
AWS_SECRET: "REPLACEME"
|
||||
|
||||
# Buffer for ????
|
||||
|
||||
# Buffer for sending to buffer
|
||||
BUFFER_ACCESS_TOKEN: "REPLACEME"
|
||||
BUFFER_FACEBOOK_ID: "REPLACEME"
|
||||
BUFFER_LINKEDIN_ID: "REPLACEME"
|
||||
|
|
@ -89,25 +95,15 @@ GA_OPTIMIZE_ID: "REPLACEME"
|
|||
JWPLAYER_API_KEY: "REPLACEME"
|
||||
JWPLAYER_API_SECRET: "REPLACEME"
|
||||
|
||||
# Keen for ????
|
||||
KEEN_API_URL: "REPLACEME"
|
||||
KEEN_PROJECT_ID: "REPLACEME"
|
||||
KEEN_READ_KEY: "REPLACEME"
|
||||
KEEN_WRITE_KEY: "REPLACEME"
|
||||
|
||||
# Mailchimp for mails duh
|
||||
# Mailchimp for mails
|
||||
MAILCHIMP_API_KEY: "REPLACEME"
|
||||
MAILCHIMP_NEWSLETTER_ID: "REPLACEME"
|
||||
MAILCHIMP_SUSTAINING_MEMBERS_ID: "REPLACEME"
|
||||
|
||||
# Google recaptcha?
|
||||
# Google recaptcha
|
||||
RECAPTCHA_SECRET: "REPLACEME"
|
||||
RECAPTCHA_SITE: "REPLACEME"
|
||||
|
||||
# Sendbird For live stream chat
|
||||
SENDBIRD_APP_ID: "REPLACEME"
|
||||
SENDBIRD_LIVECHAT_URL: "REPLACEME"
|
||||
|
||||
# Sharemeow is a text-shot service
|
||||
# more information here https://github.com/producthunt/ShareMeow
|
||||
SHARE_MEOW_BASE_URL: "REPLACEME"
|
||||
|
|
@ -130,12 +126,18 @@ STRIPE_SECRET_KEY: "REPLACEME"
|
|||
PERIODIC_EMAIL_DIGEST_MAX: 10
|
||||
PERIODIC_EMAIL_DIGEST_MIN: 2
|
||||
|
||||
#Pusher for chat/notfications
|
||||
#Pusher for DEV Connect/notfications
|
||||
PUSHER_APP_ID: "REPLACEME"
|
||||
PUSHER_CLUSTER: "REPLACEME"
|
||||
PUSHER_KEY: "REPLACEME"
|
||||
PUSHER_SECRET: "REPLACEME"
|
||||
|
||||
#For video calling in DEV Connect
|
||||
TWILIO_ACCOUNT_SID: "REPLACEME"
|
||||
TWILIO_VIDEO_API_KEY: "REPLACEME"
|
||||
TWILIO_VIDEO_API_SECRET: "REPLACEME"
|
||||
|
||||
|
||||
#For browser webpush notifications (webpush gem)
|
||||
VAPID_PUBLIC_KEY: "REPLACEME"
|
||||
VAPID_PRIVATE_KEY: "REPLACEME"
|
||||
Loading…
Add table
Reference in a new issue