Skip to content
This repository was archived by the owner on Nov 9, 2024. It is now read-only.

Commit e78d7d8

Browse files
authored
Developer workflow fixes (#110)
* Fixed issue with dev UI API endpoint * Updated UI dev instructions
1 parent 43b5603 commit e78d7d8

File tree

3 files changed

+24
-10
lines changed

3 files changed

+24
-10
lines changed

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
<p align="center">
2-
<a href="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/AnalogJ/lodestone">
3-
<img width="500" alt="lodestone_view" src="https://github.com/AnalogJ/lodestone/raw/master/web/frontend/src/assets/images/logo.png">
2+
<a href="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/LodestoneHQ/lodestone">
3+
<img width="500" alt="lodestone_view" src="https://github.com/LodestoneHQ/lodestone/raw/master/web/frontend/src/assets/images/logo.png">
44
</a>
55
</p>
66

77

88
# Lodestone - Personal Document Search & Archive
99

10-
[![GitHub license](https://img.shields.io/github/license/AnalogJ/lodestone.svg?style=flat-square)](https://github.com/AnalogJ/lodestone/blob/master/LICENSE)
10+
[![GitHub license](https://img.shields.io/github/license/LodestoneHQ/lodestone.svg?style=flat-square)](https://github.com/LodestoneHQ/lodestone/blob/master/LICENSE)
1111
[![Docker Pulls](https://img.shields.io/docker/pulls/analogj/lodestone.svg?style=flat-square)](https://hub.docker.com/r/analogj/lodestone)
1212
[![Gitter chat](https://img.shields.io/badge/chat-on%20gitter-brightgreen?style=flat-square)](https://gitter.im/lodestone-chat/devs)
13-
[![Get Notified](https://img.shields.io/badge/notify%20me-sign%20up-critical?style=flat-square)](https://forms.gle/u1RXnbocbFWqfxGb9)
1413

1514
> NOTE: Lodestone is a Work-in-Progress and is not production ready.
1615
@@ -47,7 +46,7 @@ http://localhost/web
4746

4847
Place your documents in the `/data/storage/documents` directory, and the Filesystem Collector should automatically start processing them.
4948

50-
If you would like some test documents to play with safely, you can take a look at the [AnalogJ/lodestone-test-docs](https://github.com/AnalogJ/lodestone-test-docs)
49+
If you would like some test documents to play with safely, you can take a look at the [LodestoneHQ/lodestone-test-docs](https://github.com/LodestoneHQ/lodestone-test-docs)
5150
repository.
5251

5352
# Configuration
@@ -103,12 +102,13 @@ Here's some of my research, but you should take a look at them yourselves.
103102
docker-compose -f docker-compose.dev.yml up --force-recreate --build
104103

105104
# and the following in a different terminal
106-
cd web/frontend && ng serve --configuration=dev
105+
cd web/frontend
106+
ng run serve
107107
```
108108

109109
Place your documents in the `/data/storage/documents` directory, and the Filesystem Collector should automatically start processing them.
110110

111-
If you would like some test documents to play with safely, you can take a look at the [AnalogJ/lodestone-test-docs](https://github.com/AnalogJ/lodestone-test-docs)
111+
If you would like some test documents to play with safely, you can take a look at the [LodesoneHQ/lodestone-test-docs](https://github.com/LodestoneHQ/lodestone-test-docs)
112112
repository.
113113

114114
`find . -exec touch {} \;`
@@ -125,9 +125,22 @@ repository.
125125
| Queue | RabbitMQ | [![](https://images.microbadger.com/badges/image/analogj/lodestone:rabbitmq.svg)](https://microbadger.com/images/analogj/lodestone:rabbitmq "Get your own image badge on microbadger.com") |
126126
| OCR | Tika | [![](https://images.microbadger.com/badges/image/analogj/lodestone:tika.svg)](https://microbadger.com/images/analogj/lodestone:tika "Get your own image badge on microbadger.com") |
127127

128-
# Future Development
128+
# Contributing
129+
It is recommended that you clone all the repositories into the same parent folder (list of repositories [here](https://github.com/LodestoneHQ]))
130+
131+
Use the commands below to configure a local development environment for the Lodestone UI:
132+
133+
```bash
134+
# run the following command in 1 terminal
135+
docker-compose -f docker-compose.dev.yml up --force-recreate --build
129136

130-
Here's some of the feature's that we have targeted for future development. Check the [Lodestone Project](https://github.com/AnalogJ/lodestone/projects/1) for in-progress development status.
137+
# and the following in a different terminal
138+
cd web/frontend
139+
npm run serve
140+
```
141+
142+
143+
# Future Development
131144

132145
- Additional file types
133146
- Optional tag synchronization to cloud storage providers (Dropbox, Google Drive, etc)

web/frontend/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"scripts": {
55
"ng": "ng",
66
"start": "ng serve",
7+
"serve": "ng serve --configuration=dev",
78
"build": "ng build",
89
"test": "ng test",
910
"lint": "ng lint",
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
export const environment = {
2-
production: true,
2+
production: false,
33
apiBase: 'http://localhost',
44
};

0 commit comments

Comments
 (0)