Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/open-nomie/nomie6-oss
Opensource version of Nomie 6
https://github.com/open-nomie/nomie6-oss
Last synced: 3 days ago
JSON representation
Opensource version of Nomie 6
- Host: GitHub
- URL: https://github.com/open-nomie/nomie6-oss
- Owner: open-nomie
- License: mit
- Created: 2022-12-31T16:12:55.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-20T19:28:29.000Z (7 months ago)
- Last Synced: 2024-12-29T20:13:09.051Z (10 days ago)
- Language: Svelte
- Size: 5.8 MB
- Stars: 515
- Watchers: 13
- Forks: 61
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nomie 6 Open Source
Since Closing down nomie (https://nomie.app), I wanted to provide it as an open source project.
## Open Source Life Tracker / Mood Tracker / Data Journal
## Downloading and running on any HTTP server
Nomie 6 can be run on any web server without special server side code.
Latest build: [`bin/nomie6-oss.latest.zip`](https://github.com/open-nomie/nomie6-oss/raw/master/bin/nomie6-oss.latest.zip)
## Building and Running
You'll need Node >= 16 and NPM. I have not tested running this on Windows.
```bash
git clone [email protected]:happydata/nomie6-oss.git
cd nomie6-oss
npm install
npm run dev
```
## How Nomie Works
Nomie stores each record as a log - with all tracker, people and context data being stored as a string in the `log.note` field. Nomie then parses the notes to extract structured data in real time.
For example:
`Today I walked #miles(5) #mood(8)` is converted to a structure like: `{ 'miles' : 5, 'mood': 8 }`
A more complicated example would be:
`Today @em @maddy and I #walked(4) +memory`
which would be converted into something like:
```javascript
{
people:['em','maddy'],
trackers: { walked: 4},
context:['memory']
}
```
## Meet the Nouns
- **Tracker** - primarily represented by a button on the "track board". Trackers are represented by their hashtag in notes - for example: #sleep(160000).
- **Board** - a board is specific group of trackers.
- **Board Tabs** - how you switch boards on the track tab
- **Log** - a record event. A lot contains a note, a note can contain unlimited numbers of tags; e.g: #mood(4) #pizza #beer(12). Logs can contain a lat and long. Tracker Objects and their values are parsed out of the logs in real time.
- **Person** - a Person that you track in Nomie. You can track individuals by using the @username format.
- **Context** - a generic categorization / group using the +context format. For example ``Went to dinner with @mom +meal`
- **Location** - a physical location that you store and use later
## Coding Rules
- **Keep it readable** - focus on writing code that new people can easily understand and follow. If the code can't do it, then do it with comments. There's no such thing as too much commenting. (yes, I should follow my own rules)
- **Keep it under 300 lines** - the goal is to keep files under 300 lines of code. Note: Sometimes that's not feasible, and I break it often
- **Keep it flexible** - think in components. If you're doing something more than once, it most likely should be a component.
- **Keep it safe** - if you're deleting something of the users, consider using `await Interact.confirm("Are you sure")` to confirm they're action
- **Keep cleaning, organizing and testing** - this project didn't start very clean, or ready for unit testing, this should be an on going objective.
- **Use what's there**
- Tailwind CSS - is the new world
## Nomie Jingle
The Nomie Jingle was written and produced by soldilil - [see more work](https://soldilil.bandcamp.com)
## Open Source Props
- [SvelteJS](https://svelte.dev/)
- [Leaflet](https://leafletjs.com)
- [OpenStreetMap](https://openstreetmap.org)
- [Cypress](https://cypress.io)
- [PouchDB](https://pouchdb.com)
- [LocalForage](https://localforage.github.io/localForage/)
- [svelte-emoji-picker](https://github.com/joeattardi/svelte-emoji-selector)
## Trademark License
Nomie and the Blue Elephant are registered Trademarks of Happy Data, LLC. Indianapolis, IN. For a commercial use of the brand or logomark please contact [email protected]
## MIT License
Copyright 2019 Happy Data, LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.