https://github.com/anuraghazra/BugVilla
Track, Manage & Kill Bugs Effectively :knife: :beetle:
https://github.com/anuraghazra/BugVilla
bug-tracker bugtracker bugvilla dashboard nodejs reactjs redux
Last synced: 10 months ago
JSON representation
Track, Manage & Kill Bugs Effectively :knife: :beetle:
- Host: GitHub
- URL: https://github.com/anuraghazra/BugVilla
- Owner: anuraghazra
- License: mit
- Created: 2019-12-12T10:35:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T13:51:59.000Z (about 3 years ago)
- Last Synced: 2025-03-26T10:04:37.718Z (10 months ago)
- Topics: bug-tracker, bugtracker, bugvilla, dashboard, nodejs, reactjs, redux
- Language: TypeScript
- Homepage: https://bugvilla.herokuapp.com/
- Size: 5.41 MB
- Stars: 234
- Watchers: 4
- Forks: 71
- Open Issues: 46
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Track, Manage & Kill Bugs Effectively
View Demo
·
Report Bug
·
Request Feature
Universal bug tracker for everyone! BugVilla allows team members to collaborate, discuss and kill bugs effectively.
## ✨ Features
- Issue discussions
- Markdown support
- Comment reactions
- Social interactions
- User reputation system
- \# Reference other bugs
- @ Mentions users
- Notifications
- Bug labels
## Tech Stack
| Stack | - | - | - | - | - |
| -------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| FrontEnd |
Reactjs
| 
Typescript
| 
Redux
| 
Styled Components
| 
Cypress
|
| BackEnd | 
Nodejs
| 
MongoDB
| 
Heroku
| 
Express
| 
Socket.io
|
## :rocket: Quick start
Start developing locally.
### Step 1: Clone the repo
Fork the repository. then clone the repo locally by doing -
```sh
git clone https://github.com/anuraghazra/BugVilla.git
```
### Step 2: Install Dependencies
cd into the directory
```sh
cd BugVilla
```
In the root folder do npm install.
```sh
npm install
# also in client
cd client & npm install
```
### Step 3: Setup .env
To run the server you will also need to provide the `.env` variables
- create a new file .env in the root
- open [.env.EXAMPLE](./.env.EXAMPLE)
- copy the contents and paste it to the .env with valid keys
#### And you are good to go
```sh
npm run develop
```
## :open_file_folder: What's inside?
A quick look at the folder structure of this project.
.
├── client
| ├─cypress
| ├─public
│ └─src
│ ├───@bug-ui
│ ├───assets
│ ├───components
│ ├───hooks
│ ├───pages
│ ├───store
│ ├───styles
│ ├───utils
│ └───__tests__
└── server
│
├───controllers
├───middleware
├───models
├───routes
├───tests
└───utils
## :v: Contributing
After cloning & setting up the local project you can push the changes to your github fork and make a pull request.
> You can also run the tests locally to see if everything works fine with
### Running tests
```bash
npm run test
npm run cy:open
```
### Pushing the changes
```bash
git add .
git commit -m "feat: added new stuff"
git push YOUR_REPO_URL develop
```
------
Made with :heart: and javascript