Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 6a270e1

Browse files
add readme, license and code of conduct
1 parent 29cd038 commit 6a270e1

File tree

3 files changed

+132
-0
lines changed

3 files changed

+132
-0
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, 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 email address, without their 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 [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and 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 contributors 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 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
44+
45+
[homepage]: https://www.contributor-covenant.org
46+
47+
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Ben Greenberg
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Tutorial Topics from StackExchange Questions
2+
3+
This is a Node.js app that retrieves recent questions from a StackExchange site and uses ChatGPT to analyze the questions for common themes. The app is designed to help generate ideas for tutorial and blog post content based on the topics that are currently popular on a particular StackExchange site.
4+
5+
## Installation
6+
To use this app, you'll need to have Node.js installed on your machine. Once you have Node.js installed, you can clone the project from GitHub:
7+
8+
```
9+
git clone https://github.com/your-username/stackexchange-question-analyzer.git
10+
```
11+
12+
After cloning the project, navigate to the project directory and install the required dependencies:
13+
14+
```
15+
cd stackexchange-question-analyzer
16+
npm install
17+
```
18+
19+
## Configuration
20+
21+
Before you can use the app, you'll need to set up a few configuration variables. These variables can be set using environment variables or a .env file.
22+
23+
### OpenAI API Key
24+
25+
The app uses the OpenAI API to analyze the questions and generate content ideas. To use the API, you'll need an API key from OpenAI. You can obtain an API key by creating an account on the OpenAI website.
26+
27+
Once you have an API key, you can set it as an environment variable or in a .env file. To set the API key as an environment variable, run the following command in your terminal:
28+
29+
```
30+
export OPENAI_API_KEY=your-api-key
31+
```
32+
33+
To set the API key in a .env file, create a new file named .env in the project directory and add the following line:
34+
35+
```
36+
OPENAI_API_KEY=your-api-key
37+
```
38+
39+
Replace your-api-key with your actual API key.
40+
41+
### StackExchange Site
42+
The app is designed to work with a specific StackExchange site. You'll need to specify the site's API endpoint and other parameters in the index.js file. Specifically, you'll need to update the following lines of code:
43+
44+
```
45+
const apiUrl = 'STACK EXCHANGE API ENDPOINT';
46+
```
47+
48+
## Usage
49+
50+
To use the app, simply run the following command in your terminal:
51+
52+
```
53+
npm start
54+
```
55+
56+
The app will retrieve recent questions from the specified StackExchange site, analyze them using ChatGPT, and generate tutorial and blog post ideas based on the common themes. The results will be displayed in your terminal.
57+
58+
## Code of Conduct
59+
60+
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
61+
62+
## License
63+
64+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /