Code Monkey home page Code Monkey logo

gervinfung / gitignored Goto Github PK

View Code? Open in Web Editor NEW
8.0 1.0 0.0 10.01 MB

Application of Gitignored. A more UI/UX Friendly Web Application to Preview/Copy/Download Single or Multiple .gitignore File(s)

Home Page: https://gitignored.vercel.app

License: MIT License

Shell 0.49% Makefile 2.54% JavaScript 1.77% TypeScript 39.44% CSS 6.18% Rust 49.57%
gitignore-generator gitignore-templates typescript gitignored vercel nextjs event-driven orm supabase cli

gitignored's Introduction

Gitignored

Web App

A web application that let the developer generate various .gitignore templates, available here

The templates are taken from the repo gitignore of GitHub. Hence the templates generated are reliable

Here's what the developers can do with it

  1. Copy various templates as one or download as all into one zip
  2. Copy each template without downloading any templates

Home Page

Home

Templates

Templates

Docs Introduction

Docs

Docs Content

Docs

Docs API

Introduction

Introduction

Commit Time

Commit-Time

Templates

Templtes

404 Page

404

Tech Used

Aspect Name
Development Language TypeScipt
Scripting Language TypeScipt
Testing Vitest
Styling Chakra-UI
Framework NextJS
Build Automation Tool Make
Dependency Management Pnpm
Continuous Integration GitHub Actions

Make Commands

Below are the non-exhaustive listed commands that you can use to build/develop/test this app. For more command, checkout Makefile

Command Usage
make start-(development OR production OR testing OR staging) Start development
make build-(development OR production OR testing OR staging) Bundle and build the app
make install Install all dependencies
make test Run all test code
make typecheck Run typechecking for source code
make lint Run linter for source and test code
make format-check Run prettier to check source and test code format
make format Run prettier to format source and test code
make start-(development OR testing)-database Start database
make copy-env-(development OR testing) Copy environment variables

Test

It's necessary to UI snapshot test, it's also a must to write test for logical processing functions

Cli App

An Offline-first CLI application that let the developer generate various .gitignore templates

The templates are taken from the web application Gitignored, which is the GUI application of this application. The TUI application is available here

Side note: The GUI application takes the templates from gitignore of Github

Here's what the developers can do with this application

  1. View the name of all available templates
  2. Search to find out whether a name of a template exists
  3. Preview each template(s) searched, it will include the closest template if there's typo in the name searched, i.e JetBrains for jetbrain
  4. Generate template(s) to a .gitignore file, will not override current .gitignore, pass --force to forcefully override
  5. Generate template(s) to a specified directory, i.e temp/temp1, it will auto generate at as temp/temp1/.gitignore
  6. Append template(s) to an existing .gitignore file, it will create one if it does not exist
  7. Append template(s) to an existing .gitignore file of a specified directory, again it will create one if it does not exist
  8. Update the cache to receive latest templates
  9. Uninstall and remove every cache
  10. Open home page/website of this application

You don't need to have an internet connection to use it, unless you want to update the cache

Note: gitignored-cli is a work-in-progress library, so expect breaking changes in its API

Default or Help

gitignored-cli

OR

gitignored-cli --help

Default or Help

Update Available

Update Available

Default Listing

gitignored-cli template --list

Default Listing

Listing with column number specified

gitignored-cli template --list --column 8

Column Listing

Search

gitignored-cli template --search rust node java vscode jetbrain whatever

Search

Preview

gitignored-cli template --preview rust node java vscode jetbrain

Preview

Default Generate

gitignored-cli template --generate rust node java vscode jetbrain whatever

Default Generate Error Default Generate

Abort Generate

gitignored-cli template --generate rust node java vscode jetbrain whatever

Abort Generate

Force Generate

gitignored-cli template --generate rust node java vscode jetbrain whatever --force

Force Generate

Generate with outdir specified

gitignored-cli template --generate rust node java vscode jetbrain whatever --outdir temp-dev/temp-two

Outdir generate

Default Append

gitignored-cli template --append rust node java vscode jetbrain whatever

Default Append

Abort Append

gitignored-cli template --append rust node java vscode jetbrain whatever

Abort Append

Append with outdir specified

gitignored-cli template --append rust node java vscode jetbrain whatever --outdir temp-dev/temp-two

Outdir Append

Updated Cache

gitignored-cli template --update

Updated

Updating Cache

gitignored-cli template --update

Updating

Open home page in browser

gitignored-cli open-link

Open Link

Uninstall

gitignored-cli uninstall

Uninstall

Of course, input validation

Input Validation

How To Use

Install it

cargo install gitignored-cli

Run it

gitignored-cli (commands)

Tech Used

Aspect Name
Language Rust
Linting Clippy
Format Rustfmt
Build Automation Tool Make
Package Manager Cargo
Continuous Integration GitHub Actions

Make Commands

Below are the listed commands that you can use to build/develop/test this app

Command Usage
make test-dev Run all test code in development environment
make test-prod Run all test code in ci-cd
make build Bundle, build and release the app as executable
make check Run compiler checking on code
make lint Run linter for code
make format Run formatter to format the code

Contribution

Make sure you can run make, otherwise you need to run commands listed in Makefile separately

  1. Open an issue
  2. Fork this repo
  3. Write test

Changes

Refer to here

gitignored's People

Contributors

gervinfung avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.