File size: 3,360 Bytes
7d51e81
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width,initial-scale=1" />
    <title>Learnix β€” Project Overview</title>
    <link rel="stylesheet" href="./readme.css" />
  </head>
  <body>
    <header class="hero">
      <div class="wrap">
        <h1>Learnix</h1>
        <p class="lead">A lightweight learning-content sharing platform β€” Next.js + MongoDB</p>
        <p class="lead tags-row">
          <img alt="Next.js" src="https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=next.js&logoColor=white" />
          <img alt="MongoDB" src="https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white" />
          <img alt="Cloudinary" src="https://img.shields.io/badge/Cloudinary-4000FF?style=for-the-badge" />
        </p>
      </div>
    </header>

    <main class="wrap content">
      <section class="card">
        <h2>Quick Links</h2>
        <p class="muted">Open these routes locally while the dev server runs:</p>
        <ul class="nav-list">
          <li><code>/dashboard</code> β€” Dashboard</li>
          <li><code>/login</code> β€” Login / Register</li>
          <li><code>/search</code> β€” Search</li>
          <li><code>/learn</code> β€” Learn</li>
          <li><code>/works</code> β€” Uploaded Works</li>
          <li><code>/upload</code> β€” Upload (includes Updates banner)</li>
          <li><code>/upload/updates</code> β€” Manage Updates</li>
          <li><code>/materials</code> β€” Study Materials</li>
          <li><code>/qp</code> β€” Question Papers</li>
          <li><code>/tools</code> β€” Tools (TextShare, converters)</li>
          <li><code>/feedback</code> β€” Feedback</li>
          <li><code>/help</code> β€” Help</li>
        </ul>
      </section>

      <section class="card">
        <h2>Features</h2>
        <ul>
          <li>Upload & manage subjects, topics and student works</li>
          <li>Study materials browsing and question papers</li>
          <li>TextShare editor with local storage 'My Codes'</li>
          <li>Chunked file upload (frontend)</li>
          <li>Updates activity feed (create/edit/delete announcements)</li>
        </ul>
      </section>

      <section class="card">
        <h2>Tech Stack</h2>
        <p class="muted">Core technologies used</p>
        <div class="tags">
          <span>Next.js</span>
          <span>React</span>
          <span>MongoDB</span>
          <span>Mongoose</span>
          <span>Cloudinary</span>
          <span>CSS</span>
        </div>
      </section>

      <section class="card">
        <h2>Quick Start</h2>
        <pre><code>npm install
npm run dev
# open http://localhost:3000</code></pre>
      </section>

      <section class="card small">
        <h3>Developer Notes</h3>
        <ul>
          <li>Auth currently uses `localStorage.usn` to resolve server user ids. Consider JWT or sessions.</li>
          <li>Chunked upload backend endpoints are pending (frontend exists).</li>
          <li>Styles live under <code>src/app/.../styles</code>. AddUpdateForm has a CSS file under the upload updates styles.</li>
        </ul>
      </section>
    </main>

    <footer class="wrap footer">
      <small>Learnix β€” local dev preview. Generated README HTML.</small>
    </footer>
  </body>
</html>