lawik / noted

Noted

An application for keeping notes and particularly quickly capturing them via the Telegram messaging app.

I've referenced this project a lot when doing other projects since it combines a few things I like to use.

• SQLite
• Telegram bot API
• PETAL stack (Phoenix, Elixir, Tailwind CSS, Alpine.js, LiveView)

Setting it up

To get started:

• Install dependencies with mix deps.get
• Set up a Postgres database on your machine with a username and password matching the things in config/dev.exs.
• Create and migrate your database with mix ecto.setup.
• Install Node.js dependencies with npm install inside the assets directory
• Create a Telegram bot as instructed here.
• Make sure to set environment variables: TELEGRAM_BOT_SECRET and TELEGRAM_BOT_NAME to the respective values for your bot.
• Start Phoenix endpoint with mix phx.server
• To start a docker container instance docker run -p 4000:4000 -e DATABASE_URL="ecto://./database.db" -e TELEGRAM_BOT_NAME=" " -e TELEGRAM_BOT_SECRET=" " -e SECRET_KEY_BASE=" " noted and replace env var.

Now you can visit localhost:4000 from your browser.

You will be able to log in by sending the /start message with the relevant auth data to the bot.

Then any message you send the bot will be ingested and turned into a note. Including files and pictures.