Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
phyohtetarkar committed Jun 28, 2024
1 parent 20c1b82 commit aa63aee
Show file tree
Hide file tree
Showing 10 changed files with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,21 @@

E-learning frontend website build with [Next.js](https://nextjs.org/).

This project is a frontend part of [E-learning backend](https://github.com/phyohtetarkar/elearning-backend/).
**Features**:
<ul>
<li>Course Management</li>
<li>Blog Management</li>
<li>Quiz Management</li>
<li>Category</li>
<li>Tag</li>
<li>Course Bookmark</li>
<li>Course Review</li>
<li>User Management</li>
<li>AI powered content editor</li>
<li>Dark mode support</li>
</ul>

This project is a frontend part of [E-learning backend](https://github.com/phyohtetarkar/hope-elearning-backend/).

## Requirements

Expand All @@ -15,6 +29,8 @@ This project use [TinyMCE](https://www.tiny.cloud/) for some rich text editing.

## 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
Expand Down Expand Up @@ -62,3 +78,30 @@ $ npm install
$ npm run dev
```

## 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">


Binary file added images/bmc-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/course-detail-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/landing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/lesson-edit-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/lesson-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/math-equations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/quiz-learn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aa63aee

Please sign in to comment.