BugVilla

<br /> <p align="center"> <a href="https://bugvilla.herokuapp.com"> <img src="./client/src/assets/images/BugVilla.png" alt="BugVilla Logo" width="200" height="57"> </a> <h3 align="center">Track, Manage & Kill Bugs Effectively</h3> <p align="center"> <img alt="Travis (.com)" src="https://img.shields.io/travis/com/anuraghazra/BugVilla" /> <a href="https://www.codacy.com?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=anuraghazra/BugVilla&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/a789dbf2fb2045afaf67727b05fbbc68"/></a> <img alt="GitHub" src="https://img.shields.io/github/license/anuraghazra/BugVilla" /> <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/anuraghazru?style=social" /> </p> <p align="center"> <a href="https://bugvilla.herokuapp.com">View Demo</a> · <a href="https://github.com/anuraghazra/BugVilla/issues">Report Bug</a> · <a href="https://github.com/anuraghazra/BugVilla/issues">Request Feature</a> </p> </p> <p align="center">Universal bug tracker for everyone! BugVilla allows team members to collaborate, discuss and kill bugs effectively.</p>

✨ Features

• Issue discussions
• Markdown support
• Comment reactions
• Social interactions
• User reputation system
• # Reference other bugs
• @ Mentions users
• Notifications
• Bug labels

Tech Stack

| Stack | - | - | - | - | - | | -------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | FrontEnd | <p align="center"><img src="./assets/reactjs_logo.png" width="100" height="100"> <br />Reactjs</p> | <p align="center"><img src="./assets/ts_logo.png" width="100" height="100"> <br />Typescript</p> | <p align="center"><img src="./assets/redux_logo.png" width="100" height="100"> <br />Redux</p> | <p align="center"><img src="./assets/styledcompo_logo.png" width="100" height="100"> <br />Styled Components</p> | <p align="center"><img src="./assets/cy_logo.png" width="100" height="100"> <br />Cypress</p> | | BackEnd | <p align="center"><img src="./assets/nodejs_logo.png" width="100" height="100"> <br />Nodejs</p> | <p align="center"><img src="./assets/mongo_logo2.png" width="100" height="100"> <br />MongoDB</p> | <p align="center"><img src="./assets/heroku_logo.png" width="100" height="100"> <br />Heroku</p> | <p align="center"><img src="./assets/express_logo.png" width="100" height="100"> <br />Express</p> | <p align="center"><img src="./assets/socket_logo.png" width="100" height="100"> <br />Socket.io</p> |

:rocket: Quick start

Start developing locally.

Step 1: Clone the repo

Fork the repository. then clone the repo locally by doing -

git clone https://github.com/anuraghazra/BugVilla.git

Step 2: Install Dependencies

cd into the directory

cd BugVilla

In the root folder do npm install.

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
• copy the contents and paste it to the .env with valid keys

And you are good to go

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

npm run test
npm run cy:open

Pushing the changes

git add .
git commit -m "feat: added new stuff"
git push YOUR_REPO_URL develop

---

Made with :heart: and javascript