mirror of
https://github.com/cupcakearmy/cryptgeon.git
synced 2024-12-22 16:26:28 +00:00
71 lines
1.8 KiB
Markdown
71 lines
1.8 KiB
Markdown
<p align="center">
|
|
<img src="./design/Github.png">
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
## About?
|
|
|
|
_cryptgeon_ is a secure, open source sharing note service inspired by [_PrivNote_](https://privnote.com)
|
|
|
|
## Demo
|
|
|
|
Check out the demo and see for yourself https://cryptgeon.nicco.io.
|
|
|
|
## Features
|
|
|
|
- server cannot decrypt contents due to client side encryption
|
|
- view and time constrains
|
|
- in memory, no persistence
|
|
- obligatory dark mode support
|
|
|
|
## How does it work?
|
|
|
|
each note has a 512bit generated <i>id</i> that is used to retrieve the note. data is stored in memory and never persisted to disk.
|
|
|
|
## Screenshot
|
|
|
|
|
|
|
|
## Deployment
|
|
|
|
Docker is the easiest way. There is the [official image here](https://hub.docker.com/r/cupcakearmy/cryptgeon).
|
|
|
|
```yaml
|
|
# docker-compose.yml
|
|
|
|
version: '3.7'
|
|
|
|
services:
|
|
memcached:
|
|
image: memcached:1-alpine
|
|
entrypoint: memcached -m 128 # Limit to 128 MB Ram, customize at free will.
|
|
|
|
app:
|
|
image: cupcakearmy/cryptgeon:latest
|
|
depends_on:
|
|
- memcache
|
|
ports:
|
|
- 80:5000
|
|
```
|
|
|
|
## Development
|
|
|
|
1. Clone
|
|
2. run `npm i` in the root and and client `client/` folders.
|
|
3. Run `npm run dev` to start development.
|
|
|
|
Running `npm run dev` in the root folder will start the following things
|
|
|
|
- a memcache docker container
|
|
- rust backend with hot reload
|
|
- client with hot reload
|
|
|
|
You can see the app under [localhost:3000](http://localhost:3000).
|
|
|
|
###### Attributions
|
|
|
|
Icons made by <a href="https://www.freepik.com" title="Freepik">freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>
|