Merge pull request #1 from phyohtetarkar/develop

Phase 1 release

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

.github/FUNDING.yml

@@ -0,0 +1,14 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+custom: ['https://www.buymeacoffee.com/yzox2vc1i']

.gitignore

@@ -0,0 +1,39 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+.vscode
+/public/tinymce/

README.md

@@ -1,2 +1,112 @@
-# elearning-web
-E-learning frontend project
+# E-learning web
+
+E-learning frontend website build with [Next.js](https://nextjs.org/).
+
+**Features**:
+<ul>
+	<li>- [x] Course Management</li>
+	<li>- [x] Blog Management</li>
+	<li>- [x] Quiz Management</li>
+	<li>- [x] Category</li>
+	<li>- [x] Tag</li>
+	<li>- [x] Course Bookmark</li>
+	<li>- [x] Course Review</li>
+	<li>- [x] User Management</li>
+	<li>- [x] AI powered content editor</li>
+	<li>- [x] Dark mode support</li>
+	<li>- [ ] Subscription</li>
+</ul>
+
+This project is a frontend part of [E-learning backend](https://github.com/phyohtetarkar/hope-elearning-backend/).
+
+## Requirements
+
+<ol>
+	<li>Node.js 18.17 or later</li>
+	<li>TinyMCE self-hosted</li>
+</ol>
+
+This project use [TinyMCE](https://www.tiny.cloud/) for some rich text editing. You need to download TinyMCE self-hosted source [here](https://www.tiny.cloud/get-tiny/self-hosted/) and then unzip and place inside **public** folder or you can host anywhere you wish to place. Read more about TinyMCE self-hosted [here](https://www.tiny.cloud/blog/get-started-with-tinymce-self-hosted/).
+
+## Installation and setup
+
+**This project use Firebase auth as authentication layer. So, you first need to setup firebase auth. Or you can use any other authentication providers like AWS Cognito, Auth0 etc., and setup accordingly.**
+
+Required `.env.local` file properties.
+
+```ini
+NEXT_PUBLIC_APP_NAME=Brand
+NEXT_PUBLIC_APP_DESC=Start a new career in the software developing industry.
+
+# http://localhost:3000 or (http|https)://yourdomain.com
+NEXT_PUBLIC_BASE_URL= 
+
+# backend api url
+NEXT_PUBLIC_API_URL= 
+
+# backend api url local for server actions & server components e.g, http://localhost:3080/api
+NEXT_PUBLIC_API_URL_LOCAL= 
+
+# Self-hosted TinyMCE source url 
+NEXT_PUBLIC_TINYMCE_SCRIPT_SOURCE=http://localhost:3000/tinymce/tinymce.min.js
+
+# Firebase config
+NEXT_PUBLIC_FIREBASE_API_KEY=
+NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
+NEXT_PUBLIC_FIREBASE_PROJECT_ID=
+NEXT_PUBLIC_FIREBASE_APP_ID=
+
+# OpenAI API Key
+OPENAI_API_KEY=
+
+# Gemini API Key
+GOOGLE_API_KEY=
+
+# Choose Default AI provider
+DEFAULT_AI_PROVIDER= # GOOGLE | OPENAI
+```
+
+Installing dependencies
+
+```bash
+$ npm install
+```
+
+## Running the app
+
+```bash
+# development
+$ npm run dev
+```
+
+## Styling and theming
+
+This project use [Tailwind CSS](https://tailwindcss.com/) with [Shadcn](https://ui.shadcn.com/) components. You can modify website's theme with shadcn cssVariables.
+
+## Support me
+
+<a href="https://www.buymeacoffee.com/yzox2vc1i">
+	<img src="images/bmc-button.png" width="200">
+</a>
+<br/>
+<br/>
+
+## Screenshots
+
+<img src="images/landing.png">
+
+<img src="images/course-detail-dark.png">
+
+<img src="images/quiz-learn.png">
+
+<img src="images/dashboard.png">
+
+<img src="images/lesson-edit.png">
+
+<img src="images/lesson-edit-dark.png">
+
+<img src="images/post-edit.png">
+
+<img src="images/math-equations.png">
+
+

components.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "default",
+  "rsc": true,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.ts",
+    "css": "src/app/globals.css",
+    "baseColor": "slate",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils"
+  }
+}

next.config.mjs

@@ -0,0 +1,47 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  logging: {
+    fetches: {
+      fullUrl: true,
+    },
+  },
+  experimental: {
+    staleTimes: {
+      dynamic: 0,
+      static: 180,
+    },
+  },
+  images: {
+    remotePatterns: [
+      {
+        protocol: "https",
+        hostname: "**",
+      },
+      {
+        protocol: "http",
+        hostname: "**",
+      },
+    ],
+  },
+  async redirects() {
+    return [
+      {
+        source: "/admin/courses/:id/lessons",
+        destination: "/admin/courses/:id",
+        permanent: true,
+      },
+      {
+        source: "/courses",
+        destination: "/browse",
+        permanent: true,
+      },
+      {
+        source: "/tags",
+        destination: "/blogs",
+        permanent: true,
+      },
+    ];
+  },
+};
+
+export default nextConfig;