A Project House is a dedicated place in your file system to store digital projects. The
caretaker application creates and maintains such a Project House. In particular, it can start a GUI server for very intuitive project management inside a browser window.
Next, you can install the
caretaker command by calling
npm install -g caretaker-in-a-project-house(On UNIX-like machines this should be preceded by a
sudoto gain administrator privileges. The global installation, caused by the
-goption, makes sure that you can call
caretakerfrom any point on your machine, and that is important.)
That should be all. You can check out if the installation succeeded by calling say
caretaker versionwhich should respond with a semver number, e.g.
1.1.4When this works, everything is fine, we are done with all the installations and you can create your first Project House.
If you already installed it and you need an update to a newer version, just call
npm install -g caretaker-in-a-project-houseagain.
A Project House is a dedicated place in your file system where your projects are hosted. It has as sophisticated storage system and therefore, you cannot just create a directory yourself. You need to call
caretaker init-house --dir=DIRinstead, where
DIRis the parent directory that holds the new Project House. If
/home/bob/Desktop/on a UNIX-like system, or
C:\Users\bob\Desktop\on a Windows machine, you call
caretaker init-house --dir=/home/bob/Desktopor
caretaker init-house --dir=C:\Users\bob\Desktoprespectively. That creates a new directory
C:\Users\bob\Desktop\ProjectHouse\, which is the root of the new Project House.
After the creation of a Project House you can start the GUI (Graphical User Interface) server to conveniently create and manage all your projects within a browser window. This server needs to run in the background and is started by the
caretaker start-server --root=ROOT --port=PORTcommand, where
ROOTis the Project House root and
PORTan (ephemeral) port number. The
--port=PORToption is optional, indeed, and defaults to port number
55555(five times five), if you omit it. For example, if we want the GUI to run on our previously created Project House, we can call
caretaker start-server --root=/home/bob/Desktop/ProjectHouseon a UNIX-like machine and
caretaker start-server --root=C:\Users\bob\DesktopThe server is then running and it keeps running. So leave the command line or terminal, open a browser and insert the following address:
http://localhost:55555/?do=homeThat should respond with the start page of the caretaker GUI.
Now, everything is running. For more information on the actual use and management of your projects, see the handbook. If you like to communicate about the program, please use the dedicated forum.
The most recent version is 1.1.4
published on January 18, 2017.
published on November 26, 2016.
caretaker-in-a-project-housepackage genuinely comprises these 3 file plus 15 more script files in a separate map:
This version 1.0.0 is the initial release on npmjs.com.
This whole version did not work. After an install with
npm install -g caretaker-in-a-project-housea subsequent call of the
caretakercommand only complained that it couldn't find all the necessary files.