Revise README for Twake Drive Legacy

Updated README to reflect the legacy status of Twake Drive and provided a link to the new version.
This commit is contained in:
Quentin Valmori
2025-11-22 09:06:34 +01:00
committed by GitHub
parent 3468ed6996
commit 0173510006
+3 -77
View File
@@ -1,82 +1,8 @@
# Twake Drive
<p align="center">
<a href="https://github.com/linagora/twake-drive">
<img src="https://github.com/linagora/twake-drive/assets/146178981/01827068-13b8-420a-9159-bf3d97220a12" alt="Logo">
</a>
# Twake Drive Legacy
<p align="center">
<b align="center">The open-source alternative to Google Drive.</b>
<br />
<a href="https://twake.app"><strong>Learn more »</strong></a>
<br />
<br />
<a href="https://t.me/+HIWCtSkvTpxiNjcy">Telegram</a>
|
<a href="https://twake-drive.com">Website</a>
|
<a href="https://github.com/linagora/twake-drive/issues">Issues</a>
|
<a href="https://github.com/linagora/twake-drive/milestones">Roadmap</a>
</p>
</p>
## About
<img width="100%!" alt="booking-screen" src="https://github.com/linagora/twake-drive/assets/14924963/e19079c6-99c4-41f5-83a2-b4ed4a8816d7">
## 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/twake-drive
```
2. Run it with Docker
```sh
cd tdrive
docker compose -f docker-compose.minimal.yml up
```
3. Open <http://localhost/> in a browser
## 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. The app will be running on port 3000
Go check the new Twake Drive: https://github.com/linagora/twake-drive
## License
Twake Drive is licensed under [Affero GPL v3](https://github.com/linagora/twake-drive/blob/main/LICENSE)
Twake Drive is licensed under [Affero GPL v3](https://github.com/linagora/twake-drive-legacy/blob/main/LICENSE)