AnandChowdhary/gitwords

Gitwords

A ZIET deployment app (React frontent with serverless Node.js functions) written in TypeScript to store your thoughts in a private GitHub repository.

๐ŸŒŸ Features

  • ๐Ÿ”’ All your content, secured in a private repository
  • โ›… Git-based version control and ZIP backups
  • ๐Ÿ”‘ Encrypted file storage (coming soon)
  • ๐Ÿ“ Local backup so you never lose your work (coming soon)
  • ๐Ÿ’ธ Free and open-sourced for the world

๐Ÿ”จ Development

To get started, add the environment variable FINDING_ANAND_ACCESS_TOKEN with your GitHub access token. Then, edit the ./common/config.ts file with your repository name and JWT config:

To start a local server:

npm run local

To log into Gitwords, you need a password. This is a hashed string located in password.txt in your private repository. Similarly, an optional secret.txt is used to sign your JWT (with a fallback to your hashed password). Initially, create an empty file and log in with an empty string, then use the โ€œChange passwordโ€ feature from the UI.

๐Ÿ“„ License

MIT ยฉ Anand Chowdhary