Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
krantheman committed Dec 1, 2022
1 parent 1fd23be commit 867ebbb
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 34 deletions.
Binary file added .github/file-preview-modified.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/home-modified.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/home.png
Binary file not shown.
Binary file added .github/search-modified.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/share-modified.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/share.png
Binary file not shown.
Binary file removed .github/shared-with-me.png
Binary file not shown.
Binary file added .github/upload-modified.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 50 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,39 @@

</div>

---
<img width="1402" alt="home" src="./.github/home-modified.png">

## Preview
<details>

#### Upload and store documents across platforms
<summary>More screenshots</summary>

<img src=".github/home.png" alt="FD home page"/>
<p>&nbsp;</p>

<img width="1402" alt="search" src="./.github/search-modified.png">

#### Share documents with others
<p>&nbsp;</p>

<img src=".github/share.png" alt="FD sharing"/>
<img width="1402" alt="upload" src="./.github/upload-modified.png">

#### Access documents shared with you
<p>&nbsp;</p>

<img src=".github/shared-with-me.png" alt="FD shared with me page"/>
<img width="1402" alt="share" src="./.github/share-modified.png">

---
<p>&nbsp;</p>

<img width="1402" alt="file-preview" src="./.github/file-preview-modified.png">

</details>

## Features

- Upload and store files across multiple platforms.
- View files and folders in List or Grid view and sort them by preference.
- Preview files such as images, videos, PDFs, etc.
- Share files or folders with others and manage their permissions.
- Post comments on files shared with you.
- Add files or folders to _favourites_ to make them easily accessible.
- Use the Search Bar to search for any file or folder in your Drive.

## Installation

Expand All @@ -33,38 +48,41 @@ To setup the repository locally follow the steps mentioned below:

1. Install bench and set up a `frappe-bench` directory by following the [installation steps](https://frappeframework.com/docs/user/en/installation).

1. Once you're in the `frappe-bench` directory, start the server
```sh
bench start
```

1. In a separate terminal instance, but same directory, get the Drive app
```sh
bench get-app https://github.com/frappe/drive
```
1. Move into your `frappe-bench` directory and get the Drive app
```sh
bench get-app https://github.com/frappe/drive
```
1. Create a new site
```sh
bench new-site drive.site
```

```sh
bench new-site drive.site
```

1. Map your site to localhost
```sh
bench --site drive.site add-to-hosts
```

```sh
bench --site drive.site add-to-hosts
```

1. Install the app onto your site
```sh
bench --site drive.site install-app drive
```

```sh
bench --site drive.site install-app drive
```

1. Start the bench server

```sh
bench start
```

1. Start the frontend development server
```sh
cd apps/drive && yarn dev
```

1. Finally, open the URL http://drive.site:8000/drive in your browser to see the app running.
```sh
cd apps/drive && yarn dev
```

---
1. Finally, open the URL http://drive.site:8000/drive in your browser to see the app running.

## Contributions and Community

Expand All @@ -75,8 +93,6 @@ There are many ways you can contribute even if you don't code:

If you want to contribute code then you can fork this repo, make changes and raise a PR. ([see how to](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork))

---
## License

[GNU Affero General Public License v3.0](LICENSE)

0 comments on commit 867ebbb

Please sign in to comment.