TypeOS

TypeOS is a design showcase for a minimalist desktop UI without many icons, just text.

Screenshot from early stage

Dependencies

• NodeJS | curl -sL https://deb.nodesource.com/setup_11.x | sudo -E bash - sudo apt-get install -y nodejs

Everything else gets automatically installed by npm.

Install

On windows do this before:

# Only do this under Windows, because some modules requires a fresh build on your computer.
# This will install the Windows build tools. This can take a very long time and needs alot of disk space...
npm install --global --production --vs2015 --add-python-to-path windows-build-tools
npm install --global --production --add-python-to-path windows-build-tools node-gyp

Solution from StackOverflow by Kevin Hernandez.

Linux/Windows/macOS

Copy this entire thing into your console:

git clone https://github.com/InstantCodee/TypeOS.git
cd TypeOS/
npm install
npm run build-css
./node_modules/.bin/electron-rebuild
npm start

And here is the explanation of each command:

1. Clone this repository and go into the directory:

git clone https://github.com/InstantCodee/TypeOS.git && cd TypeOS/

2. Change into TypeOS and install all dependencies first:

npm install

3. Next, you need to build SASS to CSS:

npm run build-css 

4. Recompile modules to make them run with Electron:

$(npm bin)/electron-rebuild

5. And then start the application:

npm start

Now TypeOS should start on your main monitor in fullscreen mode, If not tell us.

Contribute

Fell free to put your mind into this project:

1. Fork this project (button under header of GitHub).
2. Now you can make changes in the source code, because you have a copy.
3. After you're done with your changes, lets say with a bug fix, you can make a PR (= Pull Request).
4. Your PR will trigger a build test and we review your code and If all this is done we will merge your code into the offical branch and you contributed to our code. Thanks for your help.

Note: Keep your code clean and comment stuff so that other people can easily understand your code and keep your langauge in English. As example look in this file.

If you have trouble with GitHub or Git, we recommand you to read this guide to get in.

But I'm not a programmer, what can I do else?

There is no language system currently, keep that in mind.

You can help translate stuff, as example from English to French or Danish. Or you can create issues here If you find a bug or you have a feature request, but do not use it as a review system. For review, we setup a system later, maybe.

What is the goal of this project?

We want to create a showcase on how a minimalistic desktop can be when there are not many icons but mostly text. You can be inspired by this and develop your own desktop environment based on our design.