nhcarrigan/fcc-review-generator
9
0
Fork 0
generated from nhcarrigan/template
Code Issues Pull Requests 4 Actions Releases Activity

feat: update readme, clean up logging
Node.js CI / Lint and Test (push) Failing after 1m0s
Details

Browse Source
This commit is contained in:
Naomi Carrigan
2025-10-07 11:44:56 -07:00
parent 9896bff829
commit ef2d1f570e
2 changed files with 11 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -15
View File
@@ -1,20 +1,13 @@
# New Repository Template
# freeCodeCamp Review Generator
This template contains all of our basic files for a new GitHub repository. There is also a handy workflow that will create an issue on a new repository made from this template, with a checklist for the steps we usually take in setting up a new repository.
This tool allows you to compile all of freeCodeCamp's review lessons into a single PDF.
If you're starting a Node.JS project with TypeScript, we have a [specific template](https://github.com/naomi-lgbt/nodejs-typescript-template) for that purpose.
## Usage
## Readme
Delete all of the above text (including this line), and uncomment the below text to use our standard readme template.
<!-- # Project Name
Project Description
## Live Version
This page is currently deployed. [View the live website.]
1. Clone the repo, `pnpm install`.
2. Go to the freeCodeCamp repo, copy all of the review blocks into the `content` directory here. Nested directories are fine, we walk the file tree recursively. Only markdown files will be parsed.
3. Run `pnpm start` to start reading the files, compiling them into a single doc, and turning that doc into a PDF.
4. Profit.
## Feedback and Bugs
@@ -36,4 +29,4 @@ Copyright held by Naomi Carrigan.
## Contact
We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`. -->
We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`.