https://github.com/onebeyond/newsletter-generator
This repository will help us to generate a newsletter report
https://github.com/onebeyond/newsletter-generator
hacktoberfest
Last synced: about 2 months ago
JSON representation
This repository will help us to generate a newsletter report
- Host: GitHub
- URL: https://github.com/onebeyond/newsletter-generator
- Owner: onebeyond
- License: mit
- Created: 2023-04-21T04:37:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T05:39:48.000Z (10 months ago)
- Last Synced: 2025-04-12T01:15:55.030Z (about 2 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 557 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://codeclimate.com/github/onebeyond/newsletter-generator/maintainability)
[](https://codeclimate.com/github/onebeyond/newsletter-generator/test_coverage)
# newsletter-generator
## About
This repository will help you to generate the data and the template needed to the One Beyond Open Source Newsletter.
## Awesome features
- Great testing (in progress) 🍿
- Github data collection 📊
- StepSecurity data collection 🔐
- Cauldron data collection 🍲
- Npm stat data collection 📦
- Great template with EJS ⭐️
## Usage
### Installation
```
nvm use
npm i
```
### Usage
You will need to create a `.env` file with the following content:
```
GITHUB_TOKEN=thisismytoken
```
In order to generate the token please [follow this guideslines](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), only read access to public repositories is needed.
### Manual Steps
Ensure [Cauldron project](https://cauldron.io/project/7192) is updated with the last changes in the org before running the script.
### Run the script
```
DEBUG=newsletter* npm run start
```
The generated report will be located at `/output` folder.