albertroyxt / lesspod Goto Github PK

Serverless CMS (Website + Blog Engine) (In Active Development)

In 2015, carbon emissions from data centers exceeded the carbon emissions from air travel. There are 16 million websites being added to the Internet every month. Most websites require servers to host and most of the servers are underutilized. There are a lot of unused server resources costing us carbon emissions and money. We can reverse this damage by going serverless.

Lesspod's mission is to transition the Internet from server architecture to serverless architecture as soon as possible. To that end, we're building it as an open source project that anyone can utilize.

Our goal is to make it as simple as possible to host serverless websites and blogs. As we build Lesspod, we stare at the possibility of the serverless Internet.

Demo serverless website: https://lesspod.org

Lesspod helps to host free websites and blogs for people who don't want to pay for recurring hosting fees within free limits offered by cloud providers like Google Firebase and AWS Lambda (costs something). Lesspod is dynamic and offers a better alternative to static sites which can be difficult to install and manage.

We want to keep Lesspod as simple as possible for everyone to customize and build upon and it requires us to be as minimalist as practically posible.

• SQLite 3 (using sequelize ORM LOCAL ONLY for development purpose)
• Express 4 (Most popular node.js framework)
• EJS VueJS (Clean, Fast and Easiest to Learn)
• Serverless support (aws/firebase/azure etc)
• Bulma CSS framework for design
• Parcel.js Webpack 3/4 as a bundler
• js-cookie npm module (In future: Store for local storage: https://www.npmjs.com/package/store)

Note: The local api gets discarded on deploying to Firebase. So, It's vuejs talking directly to Firebase.

Key software versions. Node: 10.0.0 and NPM: 6.0.0

$ git clone https://github.com/Rajan/lesspod.git   //clone repo
$ cd lesspod  //move to project directory
$ npm install //install necessary packages 
$ node -r dotenv/config index.js //setup environment variables

Note: some npm modules may need to be installed manually.

$ cd client/vue
$ npm install
$ npm run dev

Keep things as simple to understand for others as possible. Also, add comments to any code being contributed.

Feel free to create an issue if you face problems. Kindly include your package.json, OS and browser details.

Create a firebase_init.txt file in the root with web script tags from your Firebase project. We've created two utilities for firebase deploy and rollback. fbase_prep.js will inject firebase calls.

node fbase_prep.js   // create new git branch and inject firebase scripts
node fbase_cleanup.js   // rollback changes and move back to master branch

• Authentication/Authorization using SQLite, Passport and Express
• API Module for SQLite
• Adding New Pages + Menus
• Landing Page Design
• Deployment to Firebase (WIP)
• Unit Tests for local SQLite API
• Logged In Page Design (Dashboard basic)
• Blog Post Index Design
• Blog Post View Design
• Blog settings i.e. changing logo, tagline etc. (WIP)
• Profile Page
• Editor Selection and Integration (using Quill editor)
• Comments Integration (Disqus, Facebook and ?)
• e2e testing using npm run e2e inside /client/vue dir

• Code coverage testing
• Page views tracking and reporting
• React client for Lesspod (Sai is on it)
• Theming System Design/Dev
• Plugin System Design/Dev
• More Themes
• Theme Generator Basic
• Menu Editor to re-link existing pages with Menus

• Desktop client for Lesspod

We accept pull requests. Kindly add comments to your code before sending one.