ISSUETRACKER

Software to track issues in your projects

Built with the tools and technologies:

Table of Contents

• Overview
• Features
• Repository Structure
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Deployment
• Contributing
• License

---

Overview

This is learning project which goal is to learn to create webapps with .NET Core MVC, as well as learning how to use corresponding technologies, such as HTML, CSS, Javascript, PostgreSQL, Redis, Entity Framework, LINQ, SignalR, REST API, Docker, NGINX.

---

Features

• CRUD operations with users and issues
• Replacing :shortcodes: of emojis to corresponding symbols in issues (with use of third-party API)
• Real-time comments in issues

---

Repository Structure

└── IssueTracker/
    ├── IssueTracker
    ├── IssueTracker.DAL
    ├── IssueTracker.Domain
    ├── IssueTracker.Service
    ├── IssueTracker.sln
    ├── IssueTracker.sln.DotSettings
    ├── IssueTracker.sln.DotSettings.user
    ├── docker-compose.yml
    ├── global.json
    └── nginx.conf

Getting Started

Prerequisites

For deployment:

Docker

For local install:

.NET: version 7.0
Redis
PostgreSQL
NGINX

Installation

Build the project from source:

1. Clone the IssueTracker repository:

❯ git clone https://github.com/Leplik500/IssueTracker

2. Navigate to the project directory:

❯ cd IssueTracker

3. Install the required dependencies:

PostgreSQL

1. Start the PostgreSQL service.
2. Create a database and set up the user credentials as specified in ConnectionStrings in appsettings.json.

Redis

1. Start the Redis server with the default configuration.

NGINX

1. Use nginx.conf file as configuration or change it as you need.
2. Start the NGINX service.

Install dotnet packages and build project with commands:

❯ dotnet restore
❯ dotnet build

Usage

To run the project, execute the following command:

❯ dotnet run

Deployment

To deploy this project run

❯ docker-compose up --build

---

Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the IssueTracker project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/Leplik500/IssueTracker

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

License

This project is protected under the Mozilla Public License 2.0 License. For more details, refer to the LICENSE file.