proton-drive - GitLite

KO | EN

gitlite — search

#ai #typescript #android #machine-learning #rust #deep-learning #docker #nodejs #macos #windows #cli #security #mcp #openai

proton-drive

(★ 140)

No description available.

File Explorer

Download Latest Version (.zip)

- fileMock.js
- pm-srp.js
- pmcrypto.js
- sieve.js
- styleMock.js
- lang.json
- - social_logo.png
- - app.scss
  - App.tsx
  - constants.ts
  - index.tsx
  - openpgpConfig.ts
  - PrivateApp.tsx
- - logoConfig.js
  - protondrive.svg
- .htaccess
- app.ejs
- index.d.ts
.editorconfig
.eslintrc.json
.gitignore
.gitlab-ci.yml
.prettierrc
CHANGELOG.md
jest.config.js
jest.transform.js
package-lock.json
package.json
README.md
rtl.setup.js
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/ProtonMail/proton-drive

Downloads the entire project code from GitHub to your computer.

cd proton-drive

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Proton Drive

Proton Drive built with React.

>**⚠ If you use Windows plz follow this document before anything else [how to prepare Windows](https://github.com/ProtonMail/proton-shared/wiki/setup-windows)**

## Basic installation

> :warning: if you are a proton dev, you will need the file `appConfig.json`

To set up the project, follow the steps below:

1. Clone the repository
2. `$ npm ci`
3. `$ npm start`

It's going to create a server available on https://localhost:8080

cf:

```sh
$ npm start

> proton-drive@4.0.0-beta.5 start /tmp/proton-drive
> proton-pack dev-server $npm_package_config_publicPathFlag --appMode=standalone

[proton-pack] Missing file appConfig.json.
[proton-pack] [DEPREACTION NOTICE] Please rename your file env.json to appConfig.json.
[proton-pack] Missing file env.json.
[proton-pack] ✓ generated /tmp/proton-drive/src/app/config.ts
➙ Dev server: http://localhost:8081/drive/
➙ Dev server: http://192.168.1.88:8081/drive/
➙ API: https://mail.protonmail.com/api

ℹ ｢wds｣: Project is running at http://localhost/
ℹ ｢wds｣: webpack output is served from /drive/
ℹ ｢wds｣: Content not from webpack is served from /tmp/proton-drive/dist
ℹ ｢wds｣: 404s will fallback to /drive/
ℹ ｢wdm｣:    3196 modules
ℹ ｢wdm｣: Compiled successfully.
```

> Here on the port 8081 as the 8080 was not available. We auto detect what is available.

## Commands

- `$ npm start`

Run develop server with a login page (mode standalone). It's going to run a server on the port **8080** if available.
> If it is not available we auto detect what is available

- `$ npm test`

Run the tests

- `$ npm run lint`

Lint the sources via eslint

- `$ npm run pretty`

Prettier sources (we have a hook post commit to run it)

- `$ npm run check-types`

Validate TS types

- `$ npm run bundle`

Create a bundle ready to deploy (prepare app + build + minify)

[more informations](https://github.com/ProtonMail/proton-bundler)

- `$ npm run build`

Build the app (build + minify). Bundle will run this command.

- `$ npm run build:standalone`

Same as the previous one BUT with a login page. When we deploy live,the login state is on another app.But when we only deploy this app when we dev, we need to be able to login.

- `$ npm run deploy` and `$ npm run deploy:standalone`

It's to deploy to a branch `deploy-branch`. A bundle based on `build` or `build:standalone`.

Flags:
  - `--api <key>`: type of api to use for deploy ex: blue,dev,proxy,prod
  - `--branch  <deploy-branch>`: target for the subdomain to deploy

[more informations](https://github.com/ProtonMail/proton-bundler)

- `$ npm run i18n:validate**`

Validate translations (context, format etc.)

## Create a new version

We use the command [npm version](https://docs.npmjs.com/cli/version)

## Help us to translate the project

You can help us to translate the application on [crowdin](https://crowdin.com/project/protonmail)