Skip to content

Commit 69f9f43

Browse files
committed
misc updates to reflect rebranding
1 parent f6031fa commit 69f9f43

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+3785
-24657
lines changed

404.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ permalink: /404.html
44

55
Page could not be found.
66

7-
[Here's a way back to the front page](https://lybekk.github.io/pimpim/)
7+
[Here's a way back to the front page](https://lybekk.github.io/offpim/)

README.md

+21-13
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
# pimpim
2-
pimpim - A PIM - A Personal information management system
1+
# offPIM
2+
**Formerly known as pimpim**
3+
*(rebranded as not to be confused with a "male performance product" solving a different problem)*
4+
5+
*Now also with a fancy URL*
6+
[offpim.app](https://offpim.app/)
7+
8+
offPIM - A PIM - A Personal information management system
39

410
![Dashboard screenshot](assets/img/dashboard.png)
511
![Dashboard screenshot](assets/img/dashboard-dark.png)
@@ -23,20 +29,20 @@ Features:
2329
* Open source. No proprietary technologies. No external requests. No tracking.
2430

2531
## Try
26-
[Try a live version of pimpim](https://lybekk.tech/pimpim/) (or use it permanently, as it works just as it will anywhere else). You may close the browser and tabs. Your data will still be there.
32+
[Try a live version of offPIM](https://offpim.app/) (or use it permanently, as it works just as it will anywhere else). You may close the browser and tabs. Your data will still be there.
2733

28-
* PS: Your data never leaves your browser, as it uses [PouchDB](https://pouchdb.com/), an in-browser database. The data entered into pimpim will neaver touch the server it's hosted on (unless you want to synchronize with a remote database).
34+
* PS: Your data never leaves your browser, as it uses [PouchDB](https://pouchdb.com/), an in-browser database. The data entered into offPIM will neaver touch the server it's hosted on (unless you want to synchronize with a remote database).
2935
* PS2: The downside to this however, is that the data will disappear if the browser cache/data gets deleted during an upgrade or the like. Remember to back up and/or synchronize regularly, as is crucially regarding all valuable data.
3036
* PS3: To verify the data flow, open the developer tab (F12), and check the network tab to see where the traffic goes (or rather, where it doesn't go).
3137

3238
## <a id="downloads"></a>Download
3339

3440
<div class="card">
35-
<a href="https://lybekk.tech/downloads/pimpim_desktop.AppImage" class="btn">
41+
<a href="https://lybekk.tech/downloads/offpim_desktop.AppImage" class="btn">
3642
<img src="assets/img/logo_linux.png" alt="Linux" width="32">
3743
Linux
3844
</a>
39-
<a href="https://lybekk.tech/downloads/pimpim_self_hosted.zip" class="btn">
45+
<a href="https://lybekk.tech/downloads/offpim_self_hosted.zip" class="btn">
4046
<img src="assets/img/logo_self_hosted.png" alt="Self-hosted" width="32">
4147
Self-hosted
4248
</a>
@@ -47,16 +53,18 @@ Features:
4753
*Two flavors are currently available*
4854

4955
1. **Desktop-app (Electron)**
50-
* "PIMPIM-Electron" is currently only built and tested on Linux (though it is possible to build for another OS yourself)
5156
1. [Download the app for your operating system](#downloads) (currently Linux only)
52-
2. Make it executable `$ chmod a+x path-to-file/pimpim_desktop.AppImage`
53-
3. and run! `$ ./path-to-file/pimpim_desktop.AppImage`
57+
2. Make it executable `$ chmod a+x path-to-file/offpim_desktop.AppImage`
58+
3. and run! `$ ./path-to-file/offpim_desktop.AppImage`
5459

55-
**OR**
60+
**Note:** "offPIM-Electron" is currently only built and tested on Linux (though it is possible to build for another OS yourself)
61+
62+
*OR*
5663

5764
2. **Self-hosted static bundle (SPA)**
58-
* Suitable for placing on a private VPS served by Apache, or any other http-server (I.E. python http.server or Node.js http.createServer)
59-
1. [Download](#downloads) and unzip contents in a sub-directory named `pimpim` on any HTTP-server.
65+
1. [Download](#downloads) and unzip contents in any directory (even root) on any HTTP-server.
66+
67+
**Note:** Suitable for placing on a private VPS served by Apache, or any other http-server (I.E. python http.server or Node.js http.createServer)
6068

6169
See the [documentation](docs/gettingstarted#installation) for more details and options.
6270

@@ -104,7 +112,7 @@ npm run electron:build
104112
See [documentation](docs/gettingstarted) for customization options.
105113

106114
### Security
107-
PIMPIM doesn't include any built-in security features (i.e. local encryption), and relies entirely on the surrounding environment. With this in mind, it's a good idea to keep an eye open on where your data travels.
115+
offPIM doesn't include any built-in security features (i.e. local encryption), and relies entirely on the surrounding environment. With this in mind, it's a good idea to keep an eye open on where your data travels.
108116
Using HTTPS, enforcing database permissions and other security best practices are recommended.
109117
Authentication when syncing with an external database is done through PouchDB.
110118

_config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
theme: jekyll-theme-cayman
2-
title: pimpim
2+
title: offPIM
33
description: A PIM. A personal information management system.
4-
baseurl: "/pimpim" # the subpath of your site, e.g. /blog
4+
baseurl: "/offpim" # site subpath
55
include: ['docs']
66
show_downloads: true

_data/features.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"general": [
3+
"PWA (Progressive web app)"
4+
],
5+
"tasks": [],
6+
"notes": []
7+
}

_layouts/default.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@
1616
<h1 class="project-name">{{ page.title | default: site.title | default: site.github.repository_name }}</h1>
1717
<h2 class="project-tagline">{{ page.description | default: site.description | default: site.github.project_tagline }}</h2>
1818
{% if site.github.is_project_page %}
19-
<a href="https://lybekk.tech/pimpim/" class="btn" target="_blank">Try</a>
19+
<a href="https://offpim.app/" class="btn" target="_blank">Try</a>
2020
<a href="#downloads" class="btn">Download</a>
2121
<a href="{{ site.github.repository_url }}" class="btn">View on GitHub</a>
2222
{% endif %}
2323
</header>
2424
<nav>
2525
<ul>
26-
<li><a href="{{ site.baseurl }}/">pimpim</a></li>
26+
<li><a href="{{ site.baseurl }}/">offPIM</a></li>
2727
<li><a href="{{ site.baseurl }}/docs/gettingstarted">Getting started</a></li>
2828
<li><a href="{{ site.baseurl }}/docs/apps">Apps</a></li>
2929
<li><a href="{{ site.baseurl }}/docs/roadmap">Roadmap</a></li>
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/apps.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Apps
33
---
44

5-
Included apps in PIMPIM:
5+
Included apps in offPIM:
66

77
* TOC
88
{:toc}
@@ -36,5 +36,5 @@ Work in progress
3636
Work in progress
3737

3838
## Make your own
39-
Pimpim's data model is flat and not relational, which enables other apps to use the same data if replicated to another database, I.E. CouchDB.
39+
offPIM's data model is flat and not relational, which enables other apps to use the same data if replicated to another database, I.E. CouchDB.
4040
Create a standalone app or a piece of analytics software to analyze productivity habits, semantics, interessting discoveries about yourself, or `<insert lofty idea here>`.

docs/gettingstarted.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Getting started
33
---
44

5-
Getting PIMPIM up and running can be done in several ways.
5+
Getting offPIM up and running can be done in several ways.
66

77
* TOC
88
{:toc}
@@ -11,15 +11,15 @@ Getting PIMPIM up and running can be done in several ways.
1111

1212
### The easy way - Desktop app
1313

14-
* "PIMPIM-Electron" is currently only built and tested on Linux (though it is possible to build for another OS yourself)
15-
1. Download [this AppImage file](https://lybekk.tech/downloads/pimpim_desktop.AppImage)
16-
2. Make it executable `$ chmod a+x path-to-file/pimpim_desktop.AppImage`
17-
3. and run! `$ ./path-to-file/pimpim_desktop.AppImage`
14+
* "offPIM-Electron" is currently only built and tested on Linux (though it is possible to build for another OS yourself)
15+
1. Download [this AppImage file](https://lybekk.tech/downloads/offpim_desktop.AppImage)
16+
2. Make it executable `$ chmod a+x path-to-file/offpim_desktop.AppImage`
17+
3. and run! `$ ./path-to-file/offpim_desktop.AppImage`
1818

1919
### The still-easy-but-requires-a-few-more-steps way (for techies)
2020

21-
1. [Download self-hosted PIMPIM](https://lybekk.tech/downloads/pimpim_self_hosted.zip)
22-
2. Copy contents of the zip-file to an HTTP-server of your choosing. Preferably in a sub-directory named /pimpim. If another sub-directory is wanted, see instructions below.
21+
1. [Download self-hosted offPIM](https://lybekk.tech/downloads/offpim_self_hosted.zip)
22+
2. Copy contents of the zip-file into a directory (or root) to an HTTP-server of your choosing.
2323

2424
### The hard way - Build it yourself
2525
1. Clone the repository
@@ -29,7 +29,7 @@ Getting PIMPIM up and running can be done in several ways.
2929
Example
3030
```Shell
3131
$ cd /home/user/folder
32-
$ git clone https://github.com/lybekk/pimpim.git
32+
$ git clone https://github.com/lybekk/offpim.git
3333
$ npm install
3434
$ npm run electron:build
3535
```
@@ -38,7 +38,7 @@ $ npm run electron:build
3838

3939
## Self-hosted - tested setups / Deployment options
4040

41-
pimpim is run successfully on the following deployment setups
41+
offPIM is run successfully on the following deployment setups
4242

4343
### CouchDB+Apache (Ubuntu)
4444
* Apache/2.4.29 (Ubuntu)
@@ -47,12 +47,12 @@ pimpim is run successfully on the following deployment setups
4747
### CouchDB HTTP server
4848
* Couchdb 2.3
4949
Dist contents placed directly in Fauxton's directory
50-
Serving pimpim with CouchDB's HTTP server.
51-
use pimpim/ or another sub-directory if you wish. Using pimpim for simplicity here.
50+
Serving offPIM with CouchDB's HTTP server.
51+
use offpim/ or another sub-directory if you wish. Using offpim for simplicity here.
5252

53-
- Change vue.config.js publicPath to /_utils/pimpim/
54-
- put files in opt/couchdb/share/www/pimpim/
55-
- visit http://localhost:5984/_utils/pimpim/
53+
- Change vue.config.js publicPath to /_utils/offpim/
54+
- put files in opt/couchdb/share/www/offpim/
55+
- visit http://localhost:5984/_utils/offpim/
5656

5757
Added bonus: Turning on CORS is not necessary if put directly in CouchDB's www folder.
5858

@@ -61,5 +61,5 @@ For synchronization, CouchDB can be used.
6161
Installation instructions [Install CouchDB](https://docs.couchdb.org/en/latest/install/index.html)
6262

6363
::: warning
64-
PIMPIM implements no security measures. Be sure no one else has access to the database.
64+
offPIM implements no security measures. Be sure no one else has access to the database.
6565
:::

0 commit comments

Comments
 (0)