mtlh / IssueTrack

This project was made to demonstrate a variety of skills by producing a full stack app that allows users + teams to collaborate on issues within their systems.

IssueTrack

A place for teams and individauls to come together and progress towards all their bug solving goals!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contact
4. Acknowledgments

About The Project

This project was made to demonstrate a variety of skills by producing a full stack app that allows users + teams to collaborate on issues within their systems.

(back to top)

Built With

A list of the key technologies used within this project:

Deployed to Vercel - https://issuetrack.vercel.app/

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Here is the online demo.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/Matthew-Harvey/IssueTrack.git

2. Install NPM packages

   npm install

3. Create a firebase db project for free at https://firebase.google.com/ (optional)

4. Replace config within api/firebase.ts with your new db config. (optional)

5. Run development environment

   npm run dev

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

Contact

Matthew Harvey

(back to top)

Acknowledgments

Some other useful resources that I recommend:

• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)