Skip to content

Commit f4601d0

Browse files
authored
Update README.md
1 parent faac6f2 commit f4601d0

File tree

1 file changed

+64
-1
lines changed

1 file changed

+64
-1
lines changed

README.md

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,64 @@
1-
# Practice Project
1+
<h1>CourseKrimson</h1>
2+
3+
<p>Welcome to <strong>CourseKrimson</strong>! This project provides a simple platform to showcase various tech-related courses. Contributors can add or modify courses in the <code>courseData.js</code> file, following a consistent structure.</p>
4+
5+
<h2>Table of Contents</h2>
6+
<ul>
7+
<li><a href="#project-overview">Project Overview</a></li>
8+
<li><a href="#prerequisites">Prerequisites</a></li>
9+
<li><a href="#installation">Installation</a></li>
10+
<li><a href="#how-to-add-courses">How to Add Courses</a></li>
11+
<li><a href="#running-the-project">Running the Project</a></li>
12+
<li><a href="#contributing">Contributing</a></li>
13+
<li><a href="#license">License</a></li>
14+
</ul>
15+
16+
<h2 id="project-overview">Project Overview</h2>
17+
<p>CourseKrimson allows you to view a dashboard of tech courses and detailed pages for each course. The courses are added in the <code>courseData.js</code> file, and this is where you can add your own courses as well.</p>
18+
19+
<h2 id="prerequisites">Prerequisites</h2>
20+
<ul>
21+
<li>Node.js (v12+)</li>
22+
<li>NPM or Yarn</li>
23+
<li>Basic knowledge of React</li>
24+
</ul>
25+
26+
<h2 id="installation">Installation</h2>
27+
<pre><code># Clone the repo
28+
git clone https://github.com/CourseKrimson/courseKrimson.github.io.git
29+
30+
# Navigate to project folder
31+
cd courseKrimson.github.io
32+
33+
# Install dependencies
34+
npm install
35+
</code></pre>
36+
37+
<h2 id="how-to-add-courses">How to Add Courses</h2>
38+
<p>Courses are stored in the <code>courseData.js</code> file. Follow the format below to add a new course:</p>
39+
<pre><code>const courses = {
40+
'course index number: course-title': {
41+
title: 'Course Index Number: Course Title',
42+
image: 'https://dummyimage.com/600x400/000/fff.jpg&text=Course+Image',
43+
description: 'Brief description of the course content.',
44+
content: `
45+
- Bullet point for course topic 1.
46+
- Bullet point for course topic 2.
47+
- Detailed explanation of course content.
48+
`,
49+
},
50+
// Add more courses in the same structure
51+
};
52+
</code></pre>
53+
54+
<h2 id="running-the-project">Running the Project</h2>
55+
<p>After installation, you can run the project locally:</p>
56+
<pre><code># Start the development server
57+
npm start
58+
</code></pre>
59+
60+
<h2 id="contributing">Contributing</h2>
61+
<p>Feel free to submit pull requests or issues for any improvements or suggestions.</p>
62+
63+
<h2 id="license">License</h2>
64+
<p>This project is licensed under the MIT License.</p>

0 commit comments

Comments
 (0)