{"id":41730016,"url":"https://github.com/electrified/notes","last_synced_at":"2026-01-24T23:28:35.779Z","repository":{"id":17387009,"uuid":"81878382","full_name":"electrified/notes","owner":"electrified","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-11T03:13:05.000Z","size":3240,"stargazers_count":0,"open_issues_count":14,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-15T07:27:03.152Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electrified.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-13T22:24:49.000Z","updated_at":"2020-12-19T23:55:47.000Z","dependencies_parsed_at":"2023-01-13T19:18:28.291Z","dependency_job_id":null,"html_url":"https://github.com/electrified/notes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/electrified/notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrified%2Fnotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrified%2Fnotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrified%2Fnotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrified%2Fnotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electrified","download_url":"https://codeload.github.com/electrified/notes/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electrified%2Fnotes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28738991,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T22:12:27.248Z","status":"ssl_error","status_checked_at":"2026-01-24T22:12:10.529Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-24T23:28:16.950Z","updated_at":"2026-01-24T23:28:31.357Z","avatar_url":"https://github.com/electrified.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Notes - a node.js blog engine\n\nYet another blog engine\n\n[![CircleCI](https://circleci.com/gh/electrified/notes.svg?style=svg)](https://circleci.com/gh/electrified/notes)\n\n## Prerequisites\n* Node.js\n* PostgreSQL\n* Docker (optional)\n\n## Installation with docker (Recommended)\n1. Fetch docker-compose.* files from repository `wget https://raw.githubusercontent.com/electrified/notes/master/docker-compose.yml \u0026\u0026 wget https://raw.githubusercontent.com/electrified/notes/master/docker-compose.example.yml`\n2. Copy `docker-compose.example.yml` to `docker-compose.prod.yml` Adjust database passwords and config as necessary\n3. Ensure latest images downloaded `docker-compose pull` (only if has been run before)\n4. Start the containers `docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d`\n5. Run database migrations `docker exec notes_web_1 npm run migrate`\n6. Add an admin user `docker exec -i notes_web_1 npm run createUser`\n\n### Dumping the database\n`docker exec notes_database_1 pg_dump -U notes notes \u003e db.sql`\n### Restoring the database\n`docker exec -i notes_database_1 psql -U notes notes \u003c db.sql`\n### Querying the database\n`docker exec -it notes_database_1 psql -U notes notes`\n\n## Installation without using Docker\n1. Clone this repo into e.g. `/srv/http/notes/`\n1. Install dependencies `npm install --python=/usr/bin/python2`\n2. Symlink systemd service file\n`ln -s /srv/http/notes/notes.service /etc/systemd/system`\n3. Install postgres and initdb\n`su - postgres -c \"initdb --locale en_GB.UTF-8 -D '/var/lib/postgres/data'\"``\n4. Create postgres database\n`su - postgres\ncreateuser notes -P\ncreatedb -O notes notes`\n5. configure connection strings in\n`config.(development|production).json`\n6. Run db migration to create schema\n`npm run migrate`\n7. Create an admin user\n`export NODE_ENV=production\nnpm run createUser`\n8. Enable the service `systemctl enable notes`\n9. Start the service `systemctl start notes`\n## Running\n\nSupported environment variables\n* DB_USER\n* DB_PASSWORD\n* DB_DATABASE\n* DB_HOST\n* ASSETS_DIR\n\nLog into admin area\n`/admin`\nCreate first post!\n\n## TODO\n\n* Improve 404 \u0026 500 pages\n* Check all promises usage, use promises instead of callbacks\n* write tests\n* check dependency versions\n* Darker UI?\n* Express error handling middleware to remove more boilerplate\n* Stop using Facebook's fixed-data-tables as they are unmaintained?\n* Fix window title on admin pages, make it use configured site title\n* Cache invalidation when changing published status\n* Fix HMR\n* Fix `Warning: connect.session() MemoryStore is not designed for a production environment, as it will leak memory, and will not scale past a single process.`\n* Init db with GB locale\n* Standardise log format output\n* How to perform clean shutdown\n* Make session key not hardcoded\n* Don't use HMR when in production, prebuild assets\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectrified%2Fnotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectrified%2Fnotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectrified%2Fnotes/lists"}