BugVilla

<a href="https://github.com/anuraghazra/BugVilla/issues">Report Bug</a>

<a href="https://github.com/anuraghazra/BugVilla/issues">Request Feature</a>

Features

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

Tech Stack

🚀 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

📂 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

✌️ 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 ❤️ and javascript