utsavk28 / TRINIT_Spriggan-3_DEV02

TRINIT_Spriggan-3_DEV02

Bug Management System

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

This project was built during the TRI-NIT hackathon. The video and the doc link

• Home Page
• Profile Page
• Bugs Page

Features

• The first feature which a team-leader has right to is creation of a project. While creating a project he adds all the information required such as a project_name, project_description, creation_details, project owner, users,etc.
• After the project is successfully created, the team lead will assign roles to different people in the software.
• People can join the projects as users. It would be the team lead’s decision whether he wants to appoint the user or no and which designation he wishes to assign him.
• Once the team members are assigned, the team lead along with the development team can create bugs for the particular project. Not only the development team but also users can create bugs for the project.
• After the bugs are created, one can view them all together. In order to discuss or add comments for any bug, the user must click on the bug and then he can add comments for that bug.

Brownie Features:

• Status of all the bugs is visible on the dashboard.
• Bug reports would be generated in the form of a pdf and would be mailed to the team lead.
• Specific data would be shown with statistical information (in graphical representation).
• This is a cross platform application and can be accessed using a secure header as well.

Built With

• Bootstrap
• Mongoose
• Express
• React
• NodeJs
• Socket IO
• Axios
• Redux

Getting Started

Instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Get a Mongo URI from https://cloud.mongodb.com/
2. Clone the repo

   git clone https://github.com/utsavk28/Social

3. Install NPM packages

   cd client && npm install

   cd server && npm install

4. Enter your Mongo URI and JWT Secret Token in server/config/default.json

   {
    	"mongoURI": "mongodb+srv://user:[e-mail]/test?retryWrites=true&w=majority",
    	"jwtSecret": "token"
    }

Usage

Allow Organization & Individuals to track Bugs & tackle them

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contributors

• Utsav Khatu
• Jeet Shah
• Esha Shah