Giter Club home page Giter Club logo

ecourse's Introduction

eCourse

A sleek and customizable website template designed for effortless self-hosting of your online course. this template provides a user-friendly foundation for educators and content creators to showcase their expertise.

eCourse

Demo

Use the following credentials for testing the demo:

Username: admin
Password: ecourseadmin

Tech Stack

UI Framework - Svelte

Styling - TailwindCSS

Icons - Iconify

Frontend Hosting - Cloudflare Pages

Backend - PocketBase

Backend hosting - PocketHost

Getting Started

The easiest way to get started is to run this project locally, simply run the following commands in your desired directory.

# Clone this repository
git clone https://github.com/Ilyas-Codes/eCourse.git

# Ignore the 'server' directory in Git
cd eCourse
echo "server" > .gitignore
git rm -r --cached server
git add .gitignore
git commit -m "Ignore the 'server' directory"

# Start the PocketBase server
cd server
./pocketbase serve
# Open up the Admin UI and sign in with the following credentials: [email protected] & ecourseadmin

# Start the vite server
cd client
npm install && npm run dev

Customization

All the landing page content (logo, hero headline etc) can be customized from the config.json file in the client/src directory.

You can also change the accent and background colors used throughout the app from the tailwind.config.js file in the client directory.

The PocketBase backend can basically be treated as a CMS for managing your course's content, the demo provided in this repo comes with 2 collections "modules" & "lessons" which include some placeholder data, you can simply change the data with your own. and you're good to go!

Deployment

The most straightforward method to deploy eCourse is by running the command npm run build in the client directory. This command spits out a dist folder containing an optimized and production-ready bundle. after that, you can create a pb_public directory within the server directory and place the contents of the dist folder inside of there. With these steps completed, you are now ready to deploy your entire application, encompassing both the frontend and backend, on any cloud service provider. For those seeking free alternatives, consider PocketHost and Fly.io.

Make sure to replace the VITE_PROD_PB_URL env variable in the .env file within the client directory with the production server URL where your PocketBase instance is hosted.

Feedback & Suggestions

Feel free to open an issue/PR if you find any bugs or want to request new features.

License

Licensed under the MIT License, Copyright © 2023

Need a frontend developer?

Besides contributing free stuff to the community, I'm also available to assist others in launching their apps and MVPs. If you're considering hiring a frontend dev (can do some backend too), feel free to DM me on Reddit or Leave me an Email.

ecourse's People

Contributors

ilyas-codes avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.