rajat1saxena / courselit-dev

Create/Sell courses and info products, write blogs, host podcasts on your own branded website.

Website | Getting started | Documentation

Introduction

CourseLit is a content management system (aka CMS) for starting your own online course website. It is designed keeping educators in mind. Consider it an open-source alternative to those paid tutoring sites.

It comes pre-equipped with all the basic tools you'd require to efficiently run and administer your online teaching business. Features include course authoring, student management, payment processing (via Stripe), website customization and analytics (very limited as of now).

Check out this live example to see what you can build with CourseLit. Click here.

Screenshot

Getting Started

To install CourseLit on your cloud server, please follow our official guide.

Development

The project is organised as a mono-repo. It uses Lerna for managing the mono-repo. You need to run both backend and frontend servers, located in packages/api and packages/app respectively, in order to run the portal in its entirety.

We recommend using Visual Studio Code for development as it allows you to develop your code in isolation inside a container using the Remote - Containers extension. Install both the editor and the extension.

Once you have this setup, follow these steps.

1. Add the following entries to your operating system's host file. These are required for multitenancy.

127.0.0.1       domain1.localsite.com
127.0.0.1       domain2.localsite.com
127.0.0.1       localsite.com

2. Press Ctrl + Shift + P to open the command palette of Visual Studio Code, type in "Remote-Containers: Open Workspace in Container" and press enter after selecting it.

3. Once the code opens up, open two terminal windows in your Visual Studio Code and type in the following commands to start the backend and frontend servers respectively.

• yarn lerna run dev --scope=@courselit/api --stream
• yarn lerna run dev --scope=@courselit/app --stream

The above commands are also exported as bash aliases, so you can simply type api and app in separate terminal windows to run backend and frontend servers respectively.

4. Inside the development container, open up a terminal window and type the following commands in sequence.

mongo
use app
var subscriptionExpiresAt = new Date()
subscriptionExpiresAt.setDate(subscriptionExpiresAt.getDate() + 90)

db.domains.insert({ name: "domain1", deleted: false, email: "[e-mail]" })
db.subscribers.insert({ email: "[e-mail]", subscriptionEndsAfter: subscriptionExpiresAt})

db.domains.insert({ name: "domain2", deleted: false, email: "[e-mail]" })
db.subscribers.insert({ email: "[e-mail]", subscriptionEndsAfter: subscriptionExpiresAt})

This will enable the invidual sites listed in step 1 with subscriptions valid for 90 days.

5. Visit domain1.localsite.com to see CourseLit in action.

Writing Your Own Widget

You can add additional functionality to your application via building your own widgets. Have a look at this document.

Environment variables.

Have a look at the docker-compose.yml file to know what all environment variables are available for you to tweak.