diff --git a/README.md b/README.md index 190bc7b7..13c6573d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,77 @@ -# Tdrive - Drive for the Twake Workplace +

+ + Logo + -## Run it in development mode +

twakedrive.app (🚀coming soon)

-1. Launch mongo using `docker run -p 27017:27017 -d mongo` -2. Launch frontend with `cd tdrive/frontend/; yarn dev:start` -3. Launch backend with `cd tdrive/backend/node/; SEARCH_DRIVER=mongodb DB_DRIVER=mongodb PUBSUB_TYPE=local DB_MONGO_URI=mongodb://localhost:27017 STORAGE_LOCAL_PATH=/[full-path-to-store-documents]/documents NODE_ENV=development yarn dev` -4. If you need more parameters, create/edit `tdrive/backend/node/config/development.json` file +

+ The open-source alternative to Google Drive. +
+ Learn more » +
+
+ Telegram + | + Website + | + Issues + | + Roadmap +

+

+ +## About + +booking-screen + +## Getting Started + +To get a local copy up and running, please follow these simple steps. + +1. Clone the repo + ```sh + git clone https://github.com/linagora/TDrive + ``` +2. Run it with Docker + ```sh + docker-compose up -d + ``` + + +## Development + +### Prerequisites + +- Node.js (Version: >=18.x) +- MongoDB +- Yarn _(recommended)_ + +### Setup + +1. Launch MongoDB using + ```sh + docker run -p 27017:27017 -d mongo + ``` + +2. Launch frontend with + + ```sh + cd tdrive/frontend/; yarn dev:start + ``` + +3. Launch backend with + + ```sh + cd tdrive/backend/node/; SEARCH_DRIVER=mongodb DB_DRIVER=mongodb PUBSUB_TYPE=local \ + DB_MONGO_URI=mongodb://localhost:27017 STORAGE_LOCAL_PATH=/[full-path-to-store-documents]/documents \ + NODE_ENV=development yarn dev + ``` + > If you need more parameters, create/edit ```tdrive/backend/node/config/development.json``` file + +6. App will be running on port 3000 -App will be running on port 3000. ## License -Tdrive is licensed under [Affero GPL v3 with additional terms](https://github.com/TwakeApp/Twake/blob/main/LICENSE.md) +Tdrive is licensed under [Affero GPL v3](https://github.com/linagora/TDrive/blob/main/LICENSE)