Skip to content
This repository has been archived by the owner on Mar 1, 2024. It is now read-only.

Latest commit

 

History

History
executable file
·
88 lines (57 loc) · 3.96 KB

README.md

File metadata and controls

executable file
·
88 lines (57 loc) · 3.96 KB

GPL Commit Release Downloads a Month

A Javascript web-OS for shipping production web apps. Build a fully functional web app, blog or PWA (progressive-web-app) Get started in less than 5 minutes.

Links

Features

  • Add Plugins, Themes, Stacks as easy as yarn add [extension]
  • Ship Production Apps Faster
  • 100% Javascript Stack
  • A Powerful CMS Framework (Optional)
    • Dashboard
    • Markdown Page and Post Editing System
    • Authentication, Image Management, DB

Learn more at factor.dev.

Getting started

To scaffold a new project:

$ yarn create factor-app <project-name>

$ npx create-factor-app <project-name>

It's as simple as that!

Themes

Start by using the basic Factor app starter theme

Examples

Please take a look at https://factor.dev/examples

Production deployment

To deploy, instead of running factor, you probably want to build ahead of time. Therefore, building and starting are separate commands:

yarn factor deploy <environment>

Then run now and enjoy!

Note: we recommend putting .factor in .npmignore or .gitignore.

Contributors

Andrew Powers
Andrew Powers

🐛 💻 📖
Raymond Aleman
Raymond Aleman

🎨 💻
Justin Keller
Justin Keller

💻 🔧 📓
Edgar Cheverier
Edgar Cheverier

💻

Contributing

Please refer to our Contribution Guide

Security

If you discover a security vulnerability regarding Factor, please send an e-mail to the team via letters@fiction.com! All security vulnerabilities will be promptly addressed.

License

GPL