University of Nebraska CSLC Tutoring Portal

This application is designed to facilitate communication between students and tutors by allowing students to create, manage, and track tickets for tutoring assistance. Tutors can view, modify, claim, and close these tickets, ensuring a smooth and efficient tutoring experience. Additionally, an admin panel is available for database management and data retrieval.

Explore the docs »

View Demo . Report Bug . Request Feature

Project

Contributors

Table Of Contents

• Table Of Contents
• About The Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• License
• Authors
• Acknowledgements

About The Project

There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need.

Here's why:

• Your time should be focused on creating something amazing. A project that solves a problem and helps others
• You shouldn't be doing the same tasks over and over like creating a README from scratch
• You should element DRY principles to the rest of your life 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

• Backend: Django REST framework
• Frontend: React and TypeScript
• Proxy Server: Nginx
• CSS Framework: Tailwind CSS

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.

Prerequisites

You will need the following packages and libraries in order to successfully run the application:

1. npm

   npm install npm@latest -g

2. Poetry

   curl -sSL https://install.python-poetry.org | python3 -

3. Docker

   sudo apt-get update
   sudo apt-get install docker.io

4. Python

   • Python is often pre-installed on many systems, or you can install here: Python Images

5. TypeScript

   npm install -g typescript

Installation

1. Clone the repo

   git clone https://github.com/nulzo/University-Nebraska-Tutor-Portal

2. Run Docker Compose

   docker compose up --build -d

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

License

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

Authors

• Nolan Gregory - Lead Developer - Nolan Gregory - Created the application

Acknowledgements

• ShaanCoding
• Othneil Drew
• ImgShields