You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+
## Our Standards
8
+
9
+
Examples of behavior that contributes to creating a positive environment include:
10
+
11
+
* Using welcoming and inclusive language
12
+
* Being respectful of differing viewpoints and experiences
13
+
* Gracefully accepting constructive criticism
14
+
* Focusing on what is best for the community
15
+
* Showing empathy towards other community members
16
+
17
+
Examples of unacceptable behavior by participants include:
18
+
19
+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20
+
* Trolling, insulting/derogatory comments, and personal or political attacks
21
+
* Public or private harassment
22
+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23
+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24
+
25
+
## Our Responsibilities
26
+
27
+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28
+
29
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30
+
31
+
## Scope
32
+
33
+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34
+
35
+
## Enforcement
36
+
37
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at contact@hack4impact.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38
+
39
+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40
+
41
+
## Attribution
42
+
43
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
Copy file name to clipboardExpand all lines: README.md
+16-13Lines changed: 16 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,9 @@
1
-
# flask-base
2
-
[](https://circleci.com/gh/hack4impact/flask-base)[](https://waffle.io/hack4impact/flask-base)
[](https://circleci.com/gh/hack4impact/flask-base)[](https://waffle.io/hack4impact/flask-base)
@@ -72,10 +73,12 @@ Note: if you are using a python2.x version, point the -p value towards your pyth
72
73
$ xcode-select --install
73
74
```
74
75
75
-
##### Add Environment Variables
76
+
##### Add Environment Variables
76
77
77
-
Create a file called `config.env` that contains environment variables in the following syntax: `ENVIRONMENT_VARIABLE=value`. For example,
78
-
the mailing environment variables can be set as the following. We recommend using Sendgrid for a mailing SMTP server. But anything else will work as well.
78
+
Create a file called `config.env` that contains environment variables in the following syntax: `ENVIRONMENT_VARIABLE=value`.
79
+
You may also wrap values in double quotes like `ENVIRONMENT_VARIABLE="value with spaces"`.
80
+
For example, the mailing environment variables can be set as the following.
81
+
We recommend using Sendgrid for a mailing SMTP server, but anything else will work as well.
79
82
80
83
```
81
84
MAIL_USERNAME=SendgridUsername
@@ -90,7 +93,7 @@ Other Key value pairs:
90
93
*`DATABASE_URL`: set to a postgresql database url (default is `data-dev.sqlite`)
91
94
*`REDISTOGO_URL`: set to Redis To Go URL or any redis server url (default is `http://localhost:6379`)
92
95
*`RAYGUN_APIKEY`: api key for raygun (default is `None`)
93
-
*`FLASK_CONFIG`: can be `development`, `production`, `default`, `heroku`, `unix`, or `testing`. Most of the time you will use `development` or `production`.
96
+
*`FLASK_CONFIG`: can be `development`, `production`, `default`, `heroku`, `unix`, or `testing`. Most of the time you will use `development` or `production`.
94
97
95
98
96
99
**Note: do not include the `config.env` file in any commits. This should remain private.**
@@ -181,9 +184,9 @@ Contributions are welcome! Check out our [Waffle board](https://waffle.io/hack4i
181
184
182
185
## Documentation Changes
183
186
184
-
To make changes to the documentation refer to the [Mkdocs documentation](http://www.mkdocs.org/#installation) for setup.
187
+
To make changes to the documentation refer to the [Mkdocs documentation](http://www.mkdocs.org/#installation) for setup.
185
188
186
-
To create a new documentation page, add a file to the `docs/` directory and edit `mkdocs.yml` to reference the file.
189
+
To create a new documentation page, add a file to the `docs/` directory and edit `mkdocs.yml` to reference the file.
187
190
188
191
When the new files are merged into `master` and pushed to github. Run `mkdocs gh-deploy` to update the online documentation.
0 commit comments