From 4a86b377762c5437090cd8b6bca0f1f5e0b1ad00 Mon Sep 17 00:00:00 2001 From: rob Date: Fri, 14 Jan 2022 06:22:29 -0500 Subject: [PATCH] changed to LibertyLinks This is a fork of dtp-sites, the open source web engine from DTP, LLC. Portions of this software may call this project "DTP Sites" for that reason. I honestly didn't spend a lot of time on this project, but will over time and it will grow in capability as we get more time to revisit LibertyLinks and add some finishing touches. --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a6e0aad..8d0d97e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -# Digital Telepresence Sites +# DTP Liberty Links -A content management and web hosting system based on the Digital Telepresence Platform. +A web application allowing people to create an account, configure a profile, and share a list of URLs on that profile. ## Requirements -The only qualified operated system for hosting a DTP Sites suite is [Ubuntu 20.04 LTS](https://releases.ubuntu.com/20.04/). It is acceptable to run it in a virtual machine for development and testing, but it should be run as close to bare metal as can be had for production environments. +The only qualified operating system for hosting a LibertyLinks instance is [Ubuntu 20.04 LTS](https://releases.ubuntu.com/20.04/). It is acceptable to run it in a virtual machine for development and testing, but it should be run as close to bare metal as can be had for production environments. -You will need MongoDB and MinIO installed and running before you can start DTP Sites web services. +You will need MongoDB, Redis, and MinIO installed and running before you can start DTP Sites web services. 1. [Install MongoDB](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/) -2. [Install MinIO](https://docs.min.io/docs/minio-quickstart-guide.html) +1. [Install MinIO](https://docs.min.io/docs/minio-quickstart-guide.html) -Install redis: +Install Redis: ```sh sudo apt-get install redis ``` @@ -28,16 +28,16 @@ Install application dependencies by running Yarn. You should do this on initial yarn ``` -## Starting DTP Sites In Development Mode +## Starting LibertyLinks In Development Mode 1. Make sure `NODE_ENV` is set to `local` -2. Run `./sites-start-local` in a VS Code terminal, then rename that terminal to `services`. +2. Run `./start-local` in a VS Code terminal, then rename that terminal to `services`. 3. In a new VS Code terminal, run `gulp` and rename that terminal `gulp`. 4. Open https://localhost:3000 in your web browser. You can now make changes to program source code, and the environment will automatically respond, build, pack, and re-load things as needed depending on what you did and what's open/running. -DTP Sites is a multi-tier web hosting engine built on: +LibertyLinks is a multi-tier web hosting engine built on: - [MongoDB](https://www.mongodb.com/) - [Redis](https://redis.io/) @@ -87,4 +87,6 @@ Redis simply has many different documents to describe it's many different featur ## Software License -The Digital Telepresence Platform Sites engine is licensed under the [Apache 2.0](https://spdx.org/licenses/Apache-2.0.html) open source software license. See [LICENSE](LICENSE) for more information. \ No newline at end of file +This software is based on the Digital Telepresence Platform (DTP) development suite. + +The Digital Telepresence Platform Core, and LibertyLinks, are licensed under the [Apache 2.0](https://spdx.org/licenses/Apache-2.0.html) open source software license. See [LICENSE](LICENSE) for more information. \ No newline at end of file