Matsuri

Where you can draft peacefully

Development • Getting Started • FAQ • Roadmap •

Development

Drafts

• A normal user can Sign up and Sign in
• A normal user can see it's own notes
• A normal user can create a new note
• A normal user can edit it a note using markdown
• A normal user have it's note saved automatically
• A normal user share a note with other users
  • Sharing can be done in two ways: "view only" and "write and read"
  • Shared with users can be seen in a panel

Roadmap

• chore: add TRPCError-like error handler for express
• chore: setup CI
• tests:
  • Auth
  • Log
  • Server
• Add this README.
• chore: setup tests properly
  • server
  • auth
    • basic setup
    • abstraction for testing together in other services
• feat: finish session-based authentication microservice (see keycloak standards?)
• chore: shared seed users (for faster development)
• feat: crud notes (development UI-first w/ tRPC)
  • read all notes
  • add note
  • edit note
  • delete note
  • feat: find/develop a good markdown editor
    • Traditional approach: Mantine Tiptap text editor
    • Notion-like: Yopta-Editor, editor.js and BlockNote
• feat: share notes w/ other users
• chore: tRPC protectedProcedure
• feat: sign in/sign out ui
• chore: logger service (for metrics
• chore: storage service
• chore: tailwind monorepo config
• feat: do ui library on-demand using shadcn/ui components (React + Tailwindcss + Radix UI)
• [-] chore: sdk for all services
  • Log
  • Auth
• bug: fix pnpm test env loader in turborepo cli

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Node.js
• pnpm

Installing and Running

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

# Clone this repository
$ git clone https://github.com/abehidek/matsuri

# Go into the repository
$ cd matsuri

# Install all dependencies
$ pnpm install

# Run the project
$ pnpm dev

FAQ

Is it any good?

yes.

Emailware

[Project's name] is an emailware. Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at hidek.abe@outlook.com about anything you'd want to say about this software. I'd really appreciate it!

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

---

abehidek.me  ·  GitHub @abehidek  ·  Twitter @guilhermehabe