https://github.com/chiragagg5k/bug-squash

A simple and easy to use bug tracking web application
https://github.com/chiragagg5k/bug-squash

bug-tracker hacktoberfest issue-tracker mongodb nextjs typescript

Last synced: 3 months ago
JSON representation

A simple and easy to use bug tracking web application

• Host: GitHub
• URL: https://github.com/chiragagg5k/bug-squash
• Owner: ChiragAgg5k
• License: mit
• Created: 2023-07-24T07:53:18.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-08T17:27:02.000Z (11 months ago)
• Last Synced: 2024-11-08T18:28:47.921Z (11 months ago)
• Topics: bug-tracker, hacktoberfest, issue-tracker, mongodb, nextjs, typescript
• Language: TypeScript
• Homepage: https://www.bug-squash.co/
• Size: 1.77 MB
• Stars: 4
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
| ![Thumbnail](assets/thumbnail_dark.png) | ![Logo](public/logo.png) |

| :-------------------------------------: | :----------------------: |

![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white) ![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) ![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)




Bug Squash is a bug tracking application that allows users to list their projects, assign their teammates to projects, and create tickets for bugs that need to be fixed. Users can also comment on tickets and mark them as completed. It has a simple and intuitive user interface that allows users to easily navigate the application and keep track of their projects and tickets.

## Table of Contents

-   [Table of Contents](#table-of-contents)

-   [Installation and Usage](#installation-and-usage)

-   [Contributing](#contributing)

-   [License](#license)

## Installation and Usage

To simply use the application, you can visit the [live demo](https://bug-squash.vercel.app/).

To build the application from source, follow these steps:

-   Clone the repository and change the directory to the project directory.

```bash

   git clone https://github.com/ChiragAgg5k/bug-squash

   cd bug-squash/

```

-   Install the dependencies. I recommend using [pnpm](https://pnpm.io/) to install the dependencies, but you can also use npm.

```bash

   npm install

#  pnpm install

```

-   Create a `.env` file in the root directory and add the required environment variables. You can find more information about the required environment variables [here](docs/installation.md).

-   Run the application in development mode.

```bash

   npm run dev

```

## Contributing

To contribute to this project, please fork the repository and submit a pull request. You can checkout the [working](docs/working.md) document for more information on the project's development.

## License

This project is licensed under the MIT License. For more information, please refer to the [LICENSE](../LICENSE.md) file.