Archiver

Thank you for choosing Archiver!

We are a version control manager for text documents meant for non-coders.

Prerequisites

• Node (>=6.x) and npm (>=3.x)
• PostgreSQL

Run It

npm install
npm run seed
npm run dev

If you run into any issues in regards to module mismatch, please do:

npm rebuild

OR

npm run rebuild

Adding a new project

You may add a project in two ways:

1. Click the "Project" button/icon located on the sidebar

2. Click the Home icon located on the sidebar, then click the "New Project" button

A project name, file and message is required on all new projects. You may also choose to invite other collaborators at this time.

View project details

The sidebar will be your main navigation tool.

All projects for which you have created as an author or are a collaborator on will appear on the sidebar underneath the "Project" button/icon.

Each project will have a multi-person icon which will link to the collaborators associated to that specific project.

As you click on each project, update messages specific to that project, will appear below the project name.

Clicking on a specific update message will pull up details on that update message and the document associated to that update.

Please note that all update messages are in reverse order, with the most recent updates appearing first.

Update current project

To update any project, please go to the project page.

Click the 'Update' button.

You will be prompted to select your file and enter an update message.

Once you submit your new update, the newest updated message should appear on your sidebar navigator.

Update messages

This is a required field when updating your projects.

Please enter a description of what changes you have made to your project.

These update messages will appear for all your collaborators to see.

Selecting a file

You must select the file you would like to update on a new project and on a current existing project.

This is a required field when adding a new project or updating a current project.

The file selected will be shared with all current colllaborators.

Adding collaborators

There are two ways in which you may add collaborators.

1. When adding a new project, you are given the option of adding collaborators

2. On any specified project page, you can access the collaborator information by clicking the multi-person icon on the sidebar. The collaborator information will include current collaborators, pending collaborators, and a final option to add additional collaborators.

Please note, all collaborators must be a user of Archiver in order to be added as a collaborator. To add a collaborator, please enter the email address associated to the other users account, separated by commas.

Once they have joined your project, you will see them listed as collaborators on the project and they will subsequently have access to all the project information including all past update messages.

Removing collaborators

On the collaborator page, you also have the option of removing a collaborator from a project as well as removing an invitation to collaborate on a project.

To do so, please click the "x" icon located next to their names.

My pending invitations

After signing in, you will be directed to the home page.

The homepage will also list any pending invitations you have recieved from other users, inviting you to collaborate on a project.

Invitations can only be recieved from Archiver users.

If you have no invitations, that will also be indicated.

Joining a project

Under your pending invitations, you will have an option to join a project.

To join a project, please click the icon next to the project title.

The invitation will also include the author of the project.