Skip to content

Anulesh/file-explorer

Repository files navigation

File Explorer with fuzzy search

GitHub branch checks state GitHub branch checks state Codefactor Codacy grade LoC GitHub top language Licence

Install

$ yarn install

Structure

Open in Gitpod

.
├── cypress
│   ├── components  (unit test)
│   └── ...
└── src
    ├── apis         (server)
    ├── components   (file, folder,tree)
    ├── constants    (icons etc)
    ├── context      (Global Context)
    └── helpers             (fuzzysearch, flatten)

Howto

1. Cypress

Run cypress test locally
$ yarn cypress open

2. Publishing

$ yarn changeset

Follow the instructions... and commit the changeset file. A "Version Packages" P/R will appear after CI checks. When merging it, a github action will publish the packages with resulting semver version and generate CHANGELOGS.

3. Quality

3.1 Hooks / Lint-staged

Check the .husky folder content to see what hooks are enabled. Lint-staged is used to guarantee that lint and prettier are applied automatically on commit and/or pushes.

3.2 Tests

Tests relies on cypress. All setups supports typescript path aliases.

Configuration lives in the root folder of each apps/packages. As an example see

3.3 CI

Workflow file explorer is defined in github action in .github/workflows. Currently it is doing following

  • Run the build.
  • Run cypress test.

More will be added soon

4. Deploy

NETLIFY

Preview Link : Demo

License

FOSSA Status