Skip to content

erudit-js/erudit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Erudit

Erudit is a CMS for perfect community-driven educational sites.

🚧 Erudit is under heavy development!

Getting Started

Intall erudit package:

npm install erudit

(Optionally) Create erudit.ts file to configure your Erudit project:

export default defineEruditConfig({
    language: 'ru',
    site: {
        title: 'My Awesome Site',
    },
});

Use commands provided by Erudit CLI to control your project:

npm erudit dev|build|preview

Monorepo Structure

  • packages/cog — Erudit types, schemas, tools
  • packages/cli — CLI for running, building and previewing Erudit projects
  • packages/bitran-elements — collection of default and pluggable Bitran elements
  • packages/erudit — Erudit app in form of Nuxt Layer

Local Development

  1. Fork erudit-js/erudit repository to your GitHub account and then clone it to your local device
  2. Install Bun if you does not have it already
  3. Run bun install and then bun run build

Now the project is ready for your edits. Try your changes using playground Erudit project located in playground directory.

Commands to control playground Erudit project:

bun play
bun play:prepare
bun play:build
bun play:preview

Releases

No releases published

Packages

No packages published

Languages