Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://alexanderepstein.github.io/Sandman/

An Application Built With Late Night Developers In Mind
https://alexanderepstein.github.io/Sandman/

cross-platform electron insomnia javascript productivity sleep

Last synced: about 2 months ago
JSON representation

An Application Built With Late Night Developers In Mind

Host: GitHub
URL: https://alexanderepstein.github.io/Sandman/
Owner: alexanderepstein
License: mit
Created: 2017-04-27T04:22:55.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2022-06-16T23:59:28.000Z (about 2 years ago)
Last Synced: 2024-05-02T15:25:18.497Z (about 2 months ago)
Topics: cross-platform, electron, insomnia, javascript, productivity, sleep
Language: JavaScript
Homepage: https://alexanderepstein.github.io/Sandman/
Size: 69.9 MB
Stars: 509
Watchers: 17
Forks: 29
Open Issues: 6
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: License.md
- Code of conduct: CODE_OF_CONDUCT.md

Lists

awesome-free-software - Sandman - Lets you know when to turn off the computer and sleep based on calculated sleep cycles. ([MIT](https://github.com/alexanderepstein/Sandman/blob/master/License.md)) (Software / Utilities)
awesome_mit_open_source - Sandman - Lets you know when to turn off the computer and sleep based on calculated sleep cycles. ([MIT](https://github.com/alexanderepstein/Sandman/blob/master/License.md)) (Software / Utilities)
awesome-free-software - Sandman - Lets you know when to turn off the computer and sleep based on calculated sleep cycles. (Software / Utilities)

README

# ![Sandman](https://github.com/alexanderepstein/Sandman/blob/master/assets/sleep_github.png) Sandman ![Sandman](https://github.com/alexanderepstein/Sandman/blob/master/assets/sleep_github.png)

#### an application built with late night developers in mind

![Version](https://img.shields.io/github/release/alexanderepstein/Sandman/all.svg) [![Github All Releases](https://img.shields.io/github/downloads/alexanderepstein/Sandman/total.svg)]() [![Build Status](https://travis-ci.org/alexanderepstein/Sandman.svg?branch=master)](https://travis-ci.org/alexanderepstein/Sandman) [![Libraries.io for GitHub](https://img.shields.io/librariesio/github/alexanderepstein/Sandman.svg)]()

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/12b7f0ba50924e73b3efba2927a8c3ea)](https://www.codacy.com/app/alexanderepstein/Sandman?utm_source=github.com&utm_medium=referral&utm_content=alexanderepstein/Sandman&utm_campaign=Badge_Grade) ![framework](https://img.shields.io/badge/framework-electron-blue.svg) ![platform](https://img.shields.io/badge/platform-crossplatform-lightgrey.svg) [![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=plastic)]()

![Counting Sheep](https://github.com/alexanderepstein/Sandman/blob/master/assets/giphy.gif)

## Lightweight bash version can be found here

Sandman will remind you to take a rest and that you can always come back to the work tomorrow.

A sleep cycle is a 90-minute chunk of time where your body transitions through various phases of sleep — all the way down to deep REM sleep — then back again. Some health experts believe that these 90-minute sleep cycles are the key to restful sleep. They recommend trying to sleep exactly 7.5 hours — or even 9 hours, if you have the time.

Based on your wakeup time and the sleep algorithm Sandman calculates the best times for you to sleep. It will notify you throughout the night when the optimal times to shutdown your computer and start to head to sleep and provide a button to do just that.

This application works well with https://justgetflux.com/

Inspired by http://sleepyti.me

## In Action

![Usage](https://github.com/alexanderepstein/Sandman/blob/master/assets/Usage.gif)

## Install

### Mac
Homebrew casks are the preferred method of installations (easiest to upgrade Sandman with brew cask update)

#### Homebrew install
```bash
brew tap caskroom/cask # add homebrew casks if you havent already
brew update
brew cask install sandman
```
#### Manual install
Download your respective platforms release from the downloads section.

Drag the Sandman.app from the Sandman dmg to the Applications folder. Double Clicking on the app should run it and it could be kept in the dock from here.

### Linux
Open up a terminal and navigate to the folder containing the downloaded installer files and run
#### Debian
First make sure you have the dependency libappindicator1
```bash
sudo apt-get install libappindicator1
```
then depending on your system architecture either run

```bash
sudo dpkg -i Sandman_1.9.2_amd64.deb
```
Or:
```bash
sudo dpkg -i Sandman_1.9.2_x86.deb
```
#### RedHat
```bash
sudo rpm -i Sandman.rpm
```
This will actually install Sandman as a utility application which can be accessed from your respective distributions application launchpad.

### Windows

#### Scoops install
If you use scoops https://github.com/lukesampson/scoop
You can download and install sandman with
```bash
scoop buckets add extras
scoop install sandman
```
#### Manual install
Download your respective architectures release from the downloads section.

Open up another windows explorer and navigate to your program files folder (x86 or 64 bit is irrelevant). Now drag the entire Sandman Windows folder you extracted from the downloaded zip in the previous step over to the program files folder. Go into the folder that was just dragged over and find the Sandman.exe and run it. Now the application will show up in the dock where it can be pinned.

## Downloads
To get the full sourced version run in terminal:
```bash
git clone https://github.com/alexanderepstein/Sandman
```

Otherwise to just get the application click the link before to head to the latest release page and download your respective platform.
##### [Version 1.9.2 Release](https://github.com/alexanderepstein/Sandman/releases/tag/v1.9.2)

## Uninstall

### Mac

#### Homebrew
```bash
brew cask uninstall sandman
```
#### Manual uninstall
Go to the applications folder and delete the Sandman application.

### Linux
Open up a terminal and run:
#### Debian

```bash
sudo dpkg --remove Sandman
```
#### RedHat

```bash
sudo rpm -e Sandman.rpm
```

### Windows

#### Scoops
```bash
scoop uninstall sandman
```

#### Manual uninstall
Open up the program files folder and delete the Sandman folder.

## Reviews Of Sandman

Addictive Tips Review

Softpedia Windows Review

Softpedia Mac Review

## Helping Out
It is assumed you already have node installed and therefore npm.

To download the full source code and install the Dependencies run the following lines:
```bash
git clone https://github.com/alexanderepstein/Sandman
cd Sandman
npm install
cd ..
npm start dev # this will run the application with all of the devtools open
```

If you get some error and the application wont run try running the following lines and see if that works.

### Linux/Mac
```bash
cd Sandman
sudo npm install -g
```

### Windows
Right click on the start menu icon at the bottom left and click on the option to open a command prompt in developer mode
cd to the Sandman directory then run
```bash
npm install -g
```
### CSS Compilation

The app styling was made with: [Sass](http://sass-lang.com/) `v3.3.14` [Ruby](https://www.ruby-lang.org/) `v2.3.1p112`.

To compile the stylesheet you'll only need to run the following command:
```bash
sass --watch scss:css --style compressed
```

### To Compile Source To Application

### Linux
Open a terminal to the Sandman directory
```bash
cd build
chmod a+x linux.sh
./linux.sh
```
This will build installers for Debian 32/64 bit and Redhat linux in the build/dist/installers folder

### Mac
Open a terminal to the Sandman directory
```bash
cd build
chmod a+x mac.sh
./mac.sh
```
This will build a dmg in the build folder

### Windows
Right click on the start menu icon at the bottom left and click on the option to open a command prompt in developer mode
then run
```bash
npm install -g electron-packager
```
Then once electron packager is installed to package your electron application open up a terminal and cd into the Sandman folder then run

For 64 Bit Binary:
```bash
electron-packager . Sandman --platform win32 --arch x64 --out dist/
```
For 32 Bit Binary
```bash
electron-packager . Sandman --platform win32 --arch ia32 --out dist/
```

If you have a feature you would like to add or optimizations to the original code
* Feel free to fork this repository and submit a pull request
* Add an issue labeled as an enhancement and if I think its a good idea I will do my best to implement it myself

```bash
( •_•)
( •_•)>⌐■-■
(⌐■_■)
```
## Donate
If this project helped you in any way and you feel like buying a broke college kid a cup of coffee

[![Donate](https://img.shields.io/badge/Donate-Venmo-blue.svg)](https://venmo.com/AlexanderEpstein)
[![Donate](https://img.shields.io/badge/Donate-SquareCash-green.svg)](https://cash.me/$AlexEpstein)

## License

MIT License

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.