Efficient Kanban board for small teams. Streamline project management with intuitive task organization, team collaboration, and progress tracking. Simplify teamwork, boost productivity
To install follow these steps:
- Clone this repository to your local machine.
- Open a terminal and navigate to the project folder.
- Run the following command to install dependencies using bun:
bun install
Once you have installed the dependencies, you can run the server using the following command:
bun run dev
This will start the server on port 3000. You can now access ShrinkURL in your browser by visiting http://localhost:3000
.
ShrinkURL is built using the following technologies:
- Next.js: A React framework for building server-side rendered and statically generated applications.
- TypeScript: A statically typed superset of JavaScript that compiles to plain JavaScript.
- Tailwind CSS: A utility-first CSS framework for creating custom designs quickly.
- Prettier: An opinionated code formatter that ensures consistent code style.
- ESLint: A pluggable and configurable JavaScript linter.
ShrinkURL utilizes Husky and Commitlint for ensuring consistent commit messages and running pre-commit hooks. To set up Husky and Commitlint, follow these steps:
- Install Husky and Commitlint as dev dependencies:
bun install --save-dev husky @commitlint/{config-conventional,cli}
build
: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)chore
: Regular code maintenance.ci
: Changes to your CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)docs
: Documentation only changesfeat
: A new featurefix
: A bug fixperf
: A code change that improves performancerefactor
: A code change that neither fixes a bug nor adds a featurerevert
: If the commit reverts a previous commit, it should begin withrevert:
, followed by the header of the reverted commit. In the body, it should say:This reverts commit <hash>.
, where the hash is the SHA of the commit being reverted.style
: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)test
: Adding missing tests or correcting existing tests
Now, whenever you make a commit, Husky will ensure that your commit message conforms to the conventional commit format specified by Commitlint.
Developed by Alejandro Sandí.