Skip to content

A Dockerized React App for employees to post and receive issues from each other.

Notifications You must be signed in to change notification settings

Zowie0122/issue_tracker-front

Repository files navigation

Issue Tracker Frontend

An issue tracker app that employees within a company can post and receive issues from each other. Admin account can add department, add user and update user's settings. This repo is paired with Issue Tracker API.

login issue_list issue_detail add_issue user_list

Main Features

  • This API contains two types of permissions, admin and user within each company.
  • User is able to read, post, update issues and post comments to issues.
  • User is able to update his/her own profile, like name and password.
  • Admin has all the features that a user has, plus extra permission to add a department, add a new user and reset user information like password, department, and permission.
  • A user or admin can only access the information that belongs to his/her company.

Main Technologies

  • TypeScript
  • React.js (Hooks)
  • React Hook Form
  • Redux (RTK query)
  • React Router V6
  • MUI
  • Docker

How to start

  1. This project requires this repo which is the API, please follow the instruction to start the backend server first.

  2. Copy the environment variable to .env from .env.example by

    cat .env.example >> .env
    
  3. Please install Docker if you hasn't, don't worry, it is still free 😆 !

  4. Make sure your Docker is up and running and host machine and docker environment are all available for port: 3000. Then run

    make restart
    
  5. Go to http://localhost:3000/login, log in as user

    email: tom@tomandjerry.com
    password: pAssword1@
    

    Or as admin

    email: admin@tomandjerry.com
    password: pAssword1@
    
  6. To stop the container, run

    make down
    

For more come in handy commands, please refer to Makefile

✨✨✨✨✨✨Welcome any ideas to make this project better! Happy Coding 👩🏻‍💻✨✨✨✨✨✨

About

A Dockerized React App for employees to post and receive issues from each other.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages