Skip to content

Commit fcaaf45

Browse files
committed
this commit will update the ReadME with version updates instructions, version update in package.json, and gif updates to newest frontend
1 parent d2ae7d8 commit fcaaf45

File tree

11 files changed

+27
-4
lines changed

11 files changed

+27
-4
lines changed

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,29 @@ npm run dev
101101
For now, the sign up function will create a System Admin user.
102102

103103

104+
## Returning Users: Version Update
105+
1. Navigate to the project directory and **add upstream** this [repository](https://github.com/open-source-labs/Docketeer.git) to your cloned fork.
106+
```
107+
git remote add upstream https://github.com/open-source-labs/Docketeer.git
108+
```
109+
110+
2. Pull down the updates.
111+
```
112+
git pull origin upstream
113+
```
114+
115+
3. Install new dependencies.
116+
```
117+
npm install
118+
```
119+
120+
4. You are all set! Now just enter the following command to start up Docketeer!
121+
```
122+
npm run dev
123+
```
124+
125+
126+
104127
## Twilio setup
105128
1. Follow documents found [here](https://www.twilio.com/docs/node/install) to download the helper library.
106129
2. In order to manage Twilio SMS notifications follow the [step plan](https://www.twilio.com/docs/notify/quickstart/sms#messagingservice).
@@ -130,15 +153,15 @@ You can view a list of running and exited containers, available images, volume h
130153

131154
### ➮ Live Metrics
132155
Users have real-time access to the total amount of resources (CPU, memory usage) that your containers are using and total block IO bytes by image over specific time periods.
133-
![alt text](assets/docketeer-metrics.gif)
156+
![alt text](assets/metrics.gif)
134157

135158
### ➮ Uploading
136159
Within the Image and Docker Compose tab, you pull images from DockerHub by providing `repo:version` or uploading a `.yml` file.
137160

138161
### ➮ Process Logs
139162
View process logs from any number of running or stopped containers. The table is both exportable and sortable by any parameter. You can filter logs by specifying the number of logs that you wish to receive (tail) as well as time (since). Process logs will help you analyze and debug problems faster by offering insights into what went wrong.
140163

141-
![alt text](assets/docketeer-process-logs.gif)
164+
![alt text](assets/logs.gif)
142165

143166
<br> For a full demo of Docketeer's features, visit [docketeer.org](https://www.docketeer.org/demo).
144167

assets/.DS_Store

0 Bytes
Binary file not shown.

assets/archive/.DS_Store

0 Bytes
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

assets/logs.gif

7.87 MB
Loading

assets/metrics.gif

19.1 MB
Loading

0 commit comments

Comments
 (0)