Skip to content

KrimsonSquad/courseKrimson.github.io

 
 

Repository files navigation

CourseKrimson

Welcome to CourseKrimson! This project provides a simple platform to showcase various tech-related courses. Contributors can add or modify courses in the courseData.js file, following a consistent structure.

Table of Contents

Project Overview

CourseKrimson allows you to view a dashboard of tech courses and detailed pages for each course. The courses are added in the courseData.js file, and this is where you can add your own courses as well.

Prerequisites

  • Node.js (v12+)
  • NPM or Yarn
  • Basic knowledge of React and Vite

Installation

# Clone the repo
git clone https://github.com/CourseKrimson/courseKrimson.github.io.git

Navigate to project folder

cd courseKrimson.github.io

Install dependencies

npm install

How to Add Courses

Courses are stored in the courseData.js file. Follow the format below to add a new course:

const courses = {
  'course index number: course-title': {
    title: 'Course Index Number: Course Title',
    image: 'https://dummyimage.com/600x400/000/fff.jpg&text=Course+Image',
    description: 'Brief description of the course content.',
    content: `
      - Bullet point for course topic 1.
      - Bullet point for course topic 2.
      - Detailed explanation of course content.
    `,
  },
  // Add more courses in the same structure
};

Running the Project

After installation, you can run the project locally:

# Start the development server
npm run dev

Contributing

Feel free to submit pull requests or issues for any improvements or suggestions.

License

This project is licensed under the MIT License.

About

CourseKrimson, an open-source project developed by KrimsonSquad.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 76.6%
  • Shell 9.6%
  • CSS 6.6%
  • HTML 5.5%
  • Python 1.7%