Luckysheet README

The project's README from github.com/dream-num/Luckysheet. As one markdown file: README.md.

logo

Join the chat at https://gitter.im/mengshukeji/Luckysheet follow on Twitter

English| 简体中文

Luckysheet is no longer maintained. It is recommended to use the upgraded version of Univer for production environment deployment. The new version solves problems such as large data loading, chart styles, pivot tables, formula calculations, etc., and has made many optimization designs, added import, export, printing, collaboration and other functions, improved table performance, and has a professional technical team to provide technical support.

Follow the #1454 issue for more details.

Introduction

🚀Luckysheet is an online spreadsheet like excel that is powerful, simple to configure, and completely open source.

Source Code Documentation Demo Forum
Github Online Documentation Online Demo / Cooperative editing demo Chinese Forum
Gitee Mirror Gitee Online Documentation Gitee Online Demo Google Group

Demo

Plugins

For advanced features like import, export, and printing, please use Univer

Ecosystem

Project Description
Luckysheet Vue Luckysheet and Luckyexcel in a vue cli3 project
Luckysheet Vue3 Luckysheet and Luckyexcel in a vue3 project with vite
Luckysheet React Luckysheet in a React project
Luckyexcel Node Use Luckyexcel in koa2
Luckysheet Server Java backend Luckysheet Server
Luckysheet Server Starter LuckysheetServer docker deployment startup template

Features

For a more detailed feature list, please refer to: Features

📖 Resources

📜 Changelog

Detailed changes for each release are documented in the CHANGELOG.md.

❗️ Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

✅ TODO

Managed with GitHub Projects

💪Contribution

Please make sure to read the Contributing Guide before making a pull request.

Usage

First step

Introduce dependencies through CDN

<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/css/pluginsCss.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/plugins.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/css/luckysheet.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/assets/iconfont/iconfont.css' />
<script src="https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/js/plugin.js"></script>
<script src="https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/luckysheet.umd.js"></script>

Second step

Specify a table container

<div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 0px;"></div>

Third step

Create a table

<script>
    $(function () {
        //Configuration item
        var options = {
            container: 'luckysheet' //luckysheet is the container id
        }
        luckysheet.create(options)
    })
</script>

Development

Requirements

Node.js Version >= 6

Installation

npm install
npm install gulp -g

Development

npm run dev

Package

npm run build

Partner project

Communication

Chinese community

Sponsor

Luckysheet is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider:

PayPal WeChat Alipay
Paypal Me

What's the difference between Patreon and OpenCollective?

Funds donated via Patreon go directly to support mengshukeji's work on Luckysheet. Funds donated via OpenCollective are managed with transparent expenses and will be used for compensating work and expenses for core team members or sponsoring community events. Your name/logo will receive proper recognition and exposure by donating on either platform.

Sponsors List

(Sort by time)

Authors and acknowledgment

Active Core Team Members

Community Partners

License

MIT

Copyright (c) 2020-present, mengshukeji

Luckysheet (dream-num/Luckysheet)

Searching Database…

16.6K ·GitHub
archived
What is this?Luckysheet is a completely open source online spreadsheet like Excel — a powerful, configurable Excel-style grid with formulas, charts and pivot tables that runs in the browser.
Is it a hosted service like Google Sheets, or a piece I add to my own app?A JavaScript library: you load its files in a web page, point it at a container element, and it renders the spreadsheet there. For self-hosted collaboration there is a separate Java Luckysheet Server with a Docker starter in the ecosystem.
How do I add it to a page?Three steps from the README: introduce the dependencies through a CDN, specify a table container element, then create the table pointing at it. The online demo lets you try the result before writing anything.
What do I need installed to run it?End users only need a browser — the library is client-side JavaScript pulled from a CDN. Working on Luckysheet itself requires Node.js 6 or newer with gulp-based dev and build scripts.
Is it still actively maintained?No — the project is archived and the README says plainly it is no longer maintained. For production it points to the upgraded successor Univer, which fixes large-data loading, chart styles, pivot tables and formula calculation, and adds import, export, printing and collaboration.
What can it actually do inside the sheet?Most of the Excel basics: styling and conditional formatting, merged cells, find and replace, freeze, undo and redo, filtering and sorting, plus built-in, remote and custom formulas. Enhanced functions add pivot tables, charts, comments, cooperative editing, pictures, matrix calculations and screenshots.
Does it support real-time collaboration?Yes, cooperative editing is listed among its enhanced functions and there is an online cooperative editing demo. For self-hosting, the ecosystem includes a Java-based Luckysheet Server and a LuckysheetServer Docker deployment starter template.
Can it import and export Excel files?Excel import and export are listed among the enhanced functions, but the README now says to use Univer for advanced features like import, export and printing. For xlsx support alongside Luckysheet, the ecosystem offers the Luckyexcel project, bundled in the Vue, Vue3 and React wrappers.
Does it work with React or Vue?Yes — the README's ecosystem section lists wrappers for Vue (CLI 3), Vue 3 with Vite and React, plus Luckyexcel in Node under koa2. There is also a Java backend server and a Docker starter template for deploying it.
Creator
dream-num
Size
27.5 MB
Stars
16.6K
Updated
CommitAug 19
Age
6y
Commits · 90 Days