Skip to content

OxyHQ/Noted

Repository files navigation

📝 Noted by Peable

Noted by Peable is a web-based note-taking app built with Yarn, Nuxt 3, and Supabase.

Features 🚀

  • Create, edit, and delete notes
  • Save notes automatically
  • 🔒 Secure authentication with Supabase
  • Access notes from anywhere with an internet connection

Stack 🛠️

  • Yarn
  • Nuxt.js 3: A progressive framework for building performant and scalable web applications.
  • Supabase: An open-source real-time API for PostgreSQL that allows for fast and secure access to data.

Getting started 🚀

  1. Clone this repository to your local machine using git clone https://github.com/PeableOfficial/Noted.git
  2. Navigate to the project directory using cd Noted
  3. Install dependencies with yarn install
  4. Create a .env file based on the .env.example file and fill in your Supabase credentials
  5. Start the development server using yarn run dev

Contributing 🤝

We welcome contributions from the community! If you have an idea for a new feature or have found a bug, please open an issue in this repository. If you would like to contribute code, please fork this repository and create a pull request with your changes.

🖊 Contributors:

You can find TODOs from: TODO.md