Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nfriend/tree-online
An online tree-like utility for generating ASCII folder structure diagrams. Written in TypeScript and React.
https://github.com/nfriend/tree-online
react redux tree typescript
Last synced: about 15 hours ago
JSON representation
An online tree-like utility for generating ASCII folder structure diagrams. Written in TypeScript and React.
- Host: GitHub
- URL: https://github.com/nfriend/tree-online
- Owner: nfriend
- License: apache-2.0
- Created: 2019-12-01T14:09:46.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T20:19:24.000Z (over 1 year ago)
- Last Synced: 2024-04-14T05:55:35.100Z (7 months ago)
- Topics: react, redux, tree, typescript
- Language: TypeScript
- Homepage: https://tree.nathanfriend.io
- Size: 4.06 MB
- Stars: 327
- Watchers: 5
- Forks: 25
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [tree.nathanfriend.io](https://tree.nathanfriend.io)
## What is this?
[tree.nathanfriend.io](https://tree.nathanfriend.io) is an online [tree](http://mama.indstate.edu/users/ice/tree/)-like utility for generating ASCII folder structure diagrams.
It takes input like this:
```
my-project
src
index.html
my-project.scss
build
index.html
my-project.css
```
... and transforms it into an ASCII tree diagram like this:
```
.
└── my-project/
├── src/
│ ├── index.html
│ └── my-project.scss
└── build/
├── index.html
└── my-project.css
```
### Why would I want this?
It's common to explain or discuss a file system structure on text-based sites like [StackOverflow](https://stackoverflow.com/), [GitLab](https://gitlab.com), or [GitHub](https://github.com/). But generating a nice-looking diagram like the one above is painful by hand.
## About the project
[tree.nathanfriend.io](https://tree.nathanfriend.io) is written in [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/)/[Redux](https://redux.js.org/).
Some other technologies this project uses:
- The [Flatly](https://bootswatch.com/flatly/) and [Darkly](https://bootswatch.com/darkly/) themes from [Bootswatch](https://bootswatch.com/)
- The project's theme will automatically adjust based on your OS's theme using [`prefers-color-scheme`](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) - give it a try!
- [JSONCrush](https://github.com/KilledByAPixel/JSONCrush) for efficiently saving the application's state in the URL
- [Bootstrap](https://getbootstrap.com/). In particular, its [responsive flex utilities](https://getbootstrap.com/docs/4.4/utilities/flex/)
- [Moment.js](https://momentjs.com/) and a few functions from [Lodash](https://lodash.com/)
- [GitLab CI/CD](https://docs.gitlab.com/ee/ci/) and [GitLab Pages](https://about.gitlab.com/product/pages/) for continuous integration and deployment
- If you're interested in the mechanics, check out this project's [.gitlab-ci.yml](.gitlab-ci.yml)
- [Jest](https://jestjs.io/), [TSLint](https://palantir.github.io/tslint/), and [Prettier](https://prettier.io/) for code quality
- [Renovate Bot](https://renovate.whitesourcesoftware.com/) for automatically keeping dependencies up-to-date
### `tree` implementation
If you're curious about this project's implementation of `tree`, check out [src/lib/](src/lib/), and more specifically, [src/lib/generate-tree.ts](src/lib/generate-tree.ts).
## Developing
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app), so it contains all the scripts you know and love:
### `yarn start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
### `yarn test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `yarn build`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### Deploying
This project is deployed automatically using [GitLab CI/CD](https://docs.gitlab.com/ee/ci/) to [GitLab Pages](https://about.gitlab.com/product/pages/), so simply `git push` on `master` to trigger a new deployment. For more info, see this project's [.gitlab-ci.yml](.gitlab-ci.yml).