Zernonia Keypress Save

KeyPress - an open-source blogging platform + free custom domains.

Project README

KeyPress's Logo

A keyboard-first blogging platform.
Finally write your blog post only with keys ๐ŸŽน

View Demo ยท Report Bug ยท Request Feature


KeyPress - open-source blogging platform that focused on keyboard-first experience

Introduction

KeyPress is an open-source blogging platform that focused on keyboard-first experience. It was inspired by Vercel's Platform Starter Kit.

I always wanted to build a multi-tenant platform using Nuxt3, and I finally did it! - in nuxt-rc11.

If you are interested to implement the same, checkout

  1. server/middleware/subdomain.ts - check the current domain and set srr context.
  2. app/router.option.ts - based on the ssr context, map a new route.
  3. pages/user/[siteId] - this will now be your new router root

๐Ÿš€ Features

  • ๐Ÿคฉ Free
  • ๐Ÿ“– Open-Source
  • ๐Ÿš€ Free custom domain
  • ๐ŸŒŒ Auto OG image (using Satori)

๐Ÿ”จ Built With

๐ŸŒŽ Setup

Prerequisites

Yarn

  • npm install --global yarn
    

Development

  1. Clone the repo
    git clone https://github.com/zernonia/keypress.git
    
  2. Install NPM packages
    cd keypress
    yarn install
    
  3. Run local development instance
    yarn dev
    

Supabase Database

create table domains (
  user_id uuid,
  url text not null primary key,
  active boolean,
  created_at timestamp default now()
);

create table profiles (
  id uuid default uuid_generate_v4() primary key,
  username text,
  avatar_url text,
  name text,
  created_at timestamp default now(),
  subdomain text references domains (url)
);

create table posts (
  id uuid default uuid_generate_v4() primary key,
  author_id uuid references profiles (id),
  created_at timestamp default now(),
  slug text not null,
  title text,
  body text,
  cover_img text,
  active boolean,
  tags ARRAY,
  featured boolean not null
);


create or replace view tags_view as
  select *, count(*)
  from
    (select unnest(tags) as name from posts where active is true) s
  group by name;



create or replace function public.handle_new_user()
  returns trigger as $$
  begin
    insert into public.profiles (id, avatar_url, username, name)
    values (new.id, new.raw_user_meta_data->>'avatar_url', new.raw_user_meta_data->>'user_name', new.raw_user_meta_data->>'preferred_username');
    return new;
  end;
  $$ language plpgsql security definer;


create trigger on_auth_user_created
  after insert on auth.users
  for each row execute procedure public.handle_new_user();

โž• Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Acknowledgement

  1. Nuxt 3 - Awesome framework
  2. Supabase - Super easy setup (as always)
  3. Tiptap - Awesome editor
  4. Vercel's Platform Starter Kit - Subdomain/Custom domain
  5. Vercel's new og generation

Author

Also, if you like my work, please buy me a coffee โ˜•๐Ÿ˜ณ

Logo

๐Ÿ”ฅ Contributors

๐Ÿ“œ License

Distributed under the MIT License. See LICENSE for more information.

Open Source Agenda is not affiliated with "Zernonia Keypress" Project. README Source: zernonia/keypress
Stars
229
Open Issues
3
Last Commit
11 months ago
Repository
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating