driftlet

a minimalist, modern, and performant blogging and portfolio platform.

live demo • driftlet.xyz

Note

we don't have documentation yet, you will be rick rolled if you click on the documentation in the website.

note: this is a very early-stage project. things may be broken or incomplete.

roadmap for 1.0

• create/edit/delete posts
• basic account stuff
• basic home page stuff
• links
• page tags
• an actual icon for the project
• performance optimizations
• basic theming
• page view tracker
• export markdown/data
• import markdown on upload
• maybe a wysiwyg editor but i really like the simplicity of not having one rn
• maybe image formatting or just wrap them to take the whole space since its max-w-3xl
• maybe rss if i can figure that out
• maybe more management utilities
• better seo?

configuration

create a .env or .env.local file in the root of the project and add the following:

# authentication
NEXTAUTH_SECRET=your-super-secret-key
NEXTAUTH_URL=https://my-site.com

# database connection
DATABASE_USER=user
DATABASE_PASSWORD=password
DATABASE_NAME=driftlet
DATABASE_URL="postgresql://user:password@localhost:5432/driftlet"

# pool configuration
DB_POOL_MAX_CONNECTIONS=20
DB_POOL_MIN_CONNECTIONS=2
DB_CONNECTION_TIMEOUT_MS=5000
DB_IDLE_TIMEOUT_MS=30000
DB_QUERY_TIMEOUT_MS=30000
DB_STATEMENT_TIMEOUT_MS=60000

# auto-initialization (optional)
DB_AUTO_INITIALIZE=true  # auto-create missing tables/columns

deploying

this project uses docker. run docker-compose up -d to pull the latest image from docker hub and start the app.

new images are built automatically by github actions on every push to main.

docker compose up -d

your site should now be available at port 3000, but you should use a reverse proxy to expose it to the internet. (i suggest caddy or nginx proxy manager)

getting started (dev)

1. set up the database

this project uses docker to run a postgresql database. make sure you have docker and docker-compose installed.

docker compose up -d db

2. install dependencies

npm install

3. run the development server

npm run dev

open http://localhost:3000

credentials

the database is seeded with a default user:

• username: admin
• password: password

you need to manually go to http://localhost:3000/login to login as the login button is hidden.

contributing

contributions welcome! please open an issue or submit a pull request.