Git Product home page Git Product logo

course-editor-dg's Introduction

Course Management System README

Overview

Welcome to the Course Management System! This application helps users manage courses, instructors, students, and associated details such as course name, instructor name, tags, and enrolled students. This README provides an overview of the functionality and components of the system.

##VIDEO - https://github.com/Aneeshh18/COURSE-EDITOR-DG/assets/88325646/18ea9b3e-41e2-4e5d-828a-9da831471f7b

Functionality

Course List

  • Upon launching the application, users are presented with a list of available courses.
  • Each course is displayed with its Course ID, Instructor, Course Name, Tags, and Students enrolled.
  • Users can click on the "View Details" button to see more information about a specific course.

Course Details

  • When users click on the "View Details" button for a course, they are directed to a page where they can edit the course details.
  • Users can edit the Course Name, Instructor Name, Tags, and the list of enrolled Students.
  • Changes made to the course details can be submitted by clicking the "UPDATE COURSE" button.

Components

App Component

  • The main component that wraps the entire application.
  • Utilizes React Router to handle navigation between different pages.

CourseList Component

  • Displays a list of courses fetched from an external API.
  • Each course is rendered in a table format with relevant details.
  • Utilizes custom hook useApi to fetch course data.

CourseDetails Component

  • Displays detailed information about a selected course.
  • Allows users to edit course details such as name, instructor, tags, and enrolled students.
  • Utilizes Autocomplete components from Material-UI for tag and student selection.
  • Makes use of custom hook useApi to fetch student and tag data.

useApi Hook

  • Custom hook for handling API requests.
  • Abstracts away the fetching logic, providing a clean and reusable way to fetch data from APIs.
  • Returns the fetched data, loading state, and error state.

Technologies Used

  • React: Frontend library for building user interfaces.
  • React Router: Library for handling navigation within a React application.
  • Material-UI: Component library for React applications, providing pre-built UI components.
  • TypeScript: Superset of JavaScript that adds static type-checking.
  • Fetch API: Interface for fetching resources across the network.

Setup Instructions

  1. Clone the repository to your local machine.
  2. Navigate to the project directory.
  3. Install dependencies using npm install.
  4. Run the application using npm run dev.
  5. Access the application in your browser at http://localhost:5173.

Conclusion

The Course Management System provides a user-friendly interface for managing courses and their associated details. Users can easily view course information, make edits, and update course details as needed. With its clean design and intuitive user experience, it serves as a valuable tool for course administrators and instructors.

course-editor-dg's People

Contributors

aneeshh18 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.