https://github.com/noted-eip/web
Web and Desktop application source code
https://github.com/noted-eip/web
Last synced: 5 months ago
JSON representation
Web and Desktop application source code
- Host: GitHub
- URL: https://github.com/noted-eip/web
- Owner: noted-eip
- License: gpl-3.0
- Created: 2022-06-28T19:41:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-29T08:53:12.000Z (over 2 years ago)
- Last Synced: 2024-01-30T06:59:09.889Z (over 2 years ago)
- Language: TypeScript
- Homepage: https://notes-are-noted.vercel.app/
- Size: 87.1 MB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Web & Desktop
Source code of the web and desktop application for Noted.
## Install
After cloning the repository, run the following command.
```
npm install
```
## Build
You can run the dev-server using the following command.
```
npm run start
```
## Lint
To run eslint on all sources use the following command.
```
npm run lint
```
If you're running VSCode, you can configure your editor to automatically lint your files on save.
1. Install the [ESLint VSCode extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
2. Paste the following snippet in your VSCode settings
```json
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
},
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact"
],
```
3. (Optional) If you've enabled `editor.formatOnPaste` there's a chance your files might not be linted properly. To fix it, disable this setting for `javascript`, `javascriptreact`, `typescript`, `typescriptreact`.
## Environment
| Env Name | Default | Description |
|------------------------------------|---------------------|-----------------------------|-------------------------------------------|
| `REACT_APP_API_BASE` | `https://noted-rojasdiego.koyeb.app` | URL of the Noted API |
| `REACT_APP_TOGGLE_DEV_FEATURES` | `0` | Either `0` or `1`. Toggles fast account switching and other development utilities |