Skip to content

Latest commit

 

History

History
125 lines (80 loc) · 5.02 KB

README.md

File metadata and controls

125 lines (80 loc) · 5.02 KB
Raw

Note: ⚠️ Beans is still in development, and the app is subject to change. The current version is v1.0.0-beta.1.

banner

Beans

Beans is a simple, lightweight, and fast note-taking app. It is designed to be a quick and easy way to jot down notes, ideas, and tasks.
Beans is built with simplicity in mind, and it is perfect for anyone who wants a no-frills note-taking app.

Features

  • Simple Interface: Beans has a clean and minimalistic interface that is easy to use.
  • Fast: Beans is designed to be fast and responsive, so you can quickly jot down notes without any lag.
  • Collaboration: Beans allows you to share notes with others, so you can work together on projects.
  • Web-based: Beans is a web-based app, so you can access your notes from anywhere with an internet connection.

Installation

Beans is a web-based app, so there is no need to install anything. Simply visit the Beans website to start using the app.

Join the beta: Beans is still in development. During the beta you should have a Beans account to use the app. If you want access to the beta, please contact me in DM.

Feedback

If you have any feedback or suggestions for Beans, please feel free to contact me. I would love to hear from you!

Developer Guide

Getting Started

To get started with Beans, follow these steps:

  1. Clone the repository: git clone https://github.com/arscslvt/beans.git
  2. Install the dependencies: npm install
  3. Start the development server: npm run dev or bun run dev (if you want to use Bun — Install Bun)

Setup local Supabase instance

Beans uses Supabase as the backend for storing notes. To set up a local Supabase instance for development, follow these steps:

  1. Install Docker: Docker Installation Guide
  2. Make sure Docker is running. You can check by running docker --version.
  3. You should see a /supabase folder in the root directory of the Beans project. This folder contains the necessary configuration files for setting up a local Supabase instance.
  4. Run the following command to start the Supabase instance:
supabase start
  1. Wait for the Supabase instance to start. You should see a message indicating that the instance is running.
  2. Once the Supabase instance is running, it will print out the connection details. You can use these details to connect to the local Supabase instance from the Beans app.
    Example connection details:
Started supabase local development setup.

         API URL: http://localhost:54321
          DB URL: postgresql://postgres:postgres@localhost:54322/postgres
      Studio URL: http://localhost:54323
    Inbucket URL: http://localhost:54324
        anon key: eyJh......
service_role key: eyJh......

Create a .env.local file in the root directory of the Beans project and add the following environment variables:

NEXT_PUBLIC_SUPABASE_URL=http://localhost:54321 (API URL)
NEXT_PUBLIC_SUPABASE_KEY=eyJh...... (service_role key)
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJh...... (anon key)

Load initial schema

You'll find a .sql file in the /supabase folder. You can use this file to load the initial schema into your local Supabase instance.

By executing the following command:

supabase db reset

you'll reset the database and load the initial schema.

Authentication

Beans uses Clerk for authentication. To set up Clerk for development, follow these steps:

Use Beans Clerk developer API keys

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_YWR2YW5jZWQtYmFzaWxpc2stMTEuY2xlcmsuYWNjb3VudHMuZGV2JA
CLERK_SECRET_KEY=sk_test_rra0z2gsjtvu4iPIWEKrbIKjO6ya5xIqzP9AYdnTOy

These keys are for development purposes only. Do not use them in production.

Contributing

If you would like to contribute to Beans, please follow these guidelines:

  • Fork the repository and create a new branch for your feature or bug fix.
  • Make your changes and test them thoroughly.
  • Create a pull request with a detailed description of your changes.
  • Your pull request will be reviewed, and if everything looks good, it will be merged into the main branch.

License

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

The app can be forked and edited, but you cannot republish a version or use it for commercial purposes. The only official copy of Beans is the one published by Beans.

Thank you for using Beans! 💜

I wanna thank you for using Beans and the GitHub community for supporting this project.
I hope you enjoy using Beans as much as I enjoyed building it.

If you have any feedback or suggestions, please feel free to reach out to @me. I'm always looking for ways to improve the app and make it better for everyone.

Happy note-taking! 📝

with ❤ love,
Salvatore, Creator of Beans.