Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ggranum/nodejs-file-processor-template
https://github.com/ggranum/nodejs-file-processor-template
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ggranum/nodejs-file-processor-template
- Owner: ggranum
- Created: 2018-07-10T19:50:52.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-02-07T11:41:40.000Z (12 months ago)
- Last Synced: 2024-04-17T21:21:57.589Z (10 months ago)
- Language: TypeScript
- Size: 205 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# File-processor
## Why?
I needed an example for someone of how to use Typescript and NodeJS who needed to do some file processing. Thus, a wee template for streaming a set of files through a handler.
## What's it good for?
If you are batch processing files that change or land in a folder, and you'd like to just 'watch' a folder and execute the batch whenever there is a matching change... this template is for you.
It also demonstrates file handling, injection, using Typescript with NodeJS (which is pretty common nowadays, but was rather novel back when this was first created).
## Getting Started
Assuming you're starting from zero, you'll need a few things. NodeJs, a development environment. Links follow.
### Supporting Tools
* Git: https://git-scm.com/downloads (or perhaps https://desktop.github.com if you prefer)
* WebStorm: https://www.jetbrains.com/webstorm/download/
* nodeenv: https://github.com/nodenv/nodenv
Once you've installed all of the above, clone this project and get started:
```bash
mkdir -p ~/github/youAtGithub/
cd ~/github/youAtGithub/
git clone [email protected]:ggranum/nodejs-file-processor-template.git my-file-processor
cd my-file-processor
# Remove the git directory so you can make this project yours
rm -rf ./.git
git init .
git add .
git commit -am "My New project, cloned from [email protected]:ggranum/nodejs-file-processor-template.git"
npm install
```