Skip to content

Latest commit

 

History

History
184 lines (129 loc) · 5.92 KB

README.md

File metadata and controls

184 lines (129 loc) · 5.92 KB
Raw

m00wm

Let's write a window manager from scratch

Writing an X11 window manager from scratch using penrose.

You can follow along with the development of this repo on youtube.

This is a work in progress project to build up a fully featured tiling window manager from scratch so please make sure you have an alternative desktop environment available to use in case anything breaks!

Installation

NOTE: Really do read the Makefile before installing: there's nothing harmful in there but you should always know what you are running under sudo!

Make sure you have Rust installed on your system and take a look at the default key bindings in main.rs, you will want to swap out st and dmenu_run for a terminal and program launcher you have installed if you're not using them.

With that done, read the contents of the Makefile in the root of the repo before running the following in a terminal to build and install the window manager:

$ make build && sudo make install

This should set you up for running penrose-from-scratch as a desktop session from your display manager when you log in.

Following along

The progress-so-far.md file in the root of this repository acts as a bit of a change log and reference for what we've done so far. If you're looking for a summary of what's been implemented (and when it was implemented) that's a good place to start.

m00wm

The Rust tiling Window Manager Alternative.

Papermark - The open-source DocSend alternative | Product Hunt


GitHub Repo stars Twitter Follow License

Papermark is the open-source document sharing alternative to DocSend with built-in analytics and custom domains.

Features

  • Shareable Links: Share your document securely by sending a custom link
  • Custom Branding: Add a custom domain and your own branding
  • Analytics: Get insights via document tracking and soon page-by-page analytics
  • Self-hosted, open-source: Host it yourself and hack on it

Demo

Papermark Welcome GIF

Tech Stack

Getting Started

Prerequisites

Here's what you need to be able to run Papermark:

  • Node.js (version >= 18)
  • PostgreSQL Database
  • Blob storage (currently AWS S3 or Vercel Blob)
  • Resend (for sending emails)

1. Clone the repository

git clone https://github.com/mfts/papermark.git
cd papermark

2. Install npm dependencies

npm install

3. Copy the environment variables to .env and change the values

cp .env.example .env

4. Initialize the database

npx prisma generate
npx prisma migrate deploy

5. Run the dev server

npm run dev

6. Open the app in your browser

Visit http://localhost:3000 in your browser.

Tinybird instructions

To prepare the Tinybird database, follow these steps:

  1. We use pipenv to manage my Python dependencies. If you don't have it installed, you can install it using the following command: 
    pkgx pipenv
  2. Download the Tinybird CLI from here and install it on your system.
  3. After authenticating with the Tinybird CLI, navigate to the lib/tinybird directory: 
    cd lib/tinybird
  4. Push the necessary datasources using the following command: 
    tb push datasources/*
tb push endpoints/get_*
  5. Don't forget to set the TINYBIRD_TOKEN with the appropriate rights in your .env file.

Updating Tinybird

pipenv shell
## start: pkgx-specific
cd ..
cd papermark
## end: pkgx-specific
pipenv update tinybird-cli

Contributing

Papermark is an open-source project and we welcome contributions from the community.

If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.

Our Contributors ✨