-
-
Notifications
You must be signed in to change notification settings - Fork 11
feat(dev): add devcontainer config, add instructions to README #17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
tfenster
wants to merge
1
commit into
evcc-io:main
Choose a base branch
from
tfenster:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the | ||
// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node | ||
{ | ||
"name": "evcc app", | ||
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-22-bookworm", | ||
"postCreateCommand": "npm install", | ||
"customizations": { | ||
"vscode": { | ||
"extensions": [ | ||
"esbenp.prettier-vscode" | ||
] | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,79 @@ | ||
# evcc Native App | ||
|
||
Native app wrapper for evcc UI based on [react-native](https://reactnative.dev/) and [expo.dev](https://expo.dev/). It uses [UI Kitten / Eva](https://akveo.github.io/react-native-ui-kitten/) as a design system. Native parts are written in TypeScript and kept to a minimum. | ||
|
||
## iOS Beta Testing | ||
|
||
Join the beta program via TestFlight: | ||
|
||
https://testflight.apple.com/join/8Y4elMpv | ||
|
||
## Features | ||
|
||
- Onboarding | ||
- find evcc instances in local network via mDNS | ||
- add instance manually via URL | ||
- try the app using the demo instance | ||
- Full screen evcc UI | ||
- use the app in a full screen web view | ||
- UI runs in an optimized mode that respects insets (notch, ...) | ||
- better gesture support (swipe, ...) by disabling browser zoom and overscroll | ||
- Online/offline detection | ||
- app shows loading screen when instance is not reachable | ||
- automatic reconnection when instance becomes reachable again | ||
- avoids missleading situations where the app is shown but not functional | ||
- Configured URL can be changed | ||
- in offline mode | ||
- via additional top navigation entry "Server ändern" | ||
- Light and dark mode for native UI | ||
- based on system settings (not configurable) | ||
|
||
## Screenshots | ||
|
||
 | ||
|
||
## Known limitations | ||
|
||
- Only German language is supported [#2](https://github.com/evcc-io/app/issues/2) | ||
- No support for multiple instances [#3](https://github.com/evcc-io/app/issues/3) | ||
- mDNS discovery only supports HTTP [#1](https://github.com/evcc-io/app/issues/1) | ||
- No Android release yet [#4](https://github.com/evcc-io/app/issues/4) | ||
- Not (basic) auth support [#5](https://github.com/evcc-io/app/issues/5) | ||
|
||
We'll work on these in a future release. Feel free to vote 👍 to help priorization and add new feature ideas. | ||
|
||
## Development | ||
|
||
Ensure that you've Node.js and NPM installed. Then install the dependencies: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
Follow the expo instructions to run local simulators for [iOS](https://docs.expo.dev/workflow/ios-simulator/) and [Android](https://docs.expo.dev/workflow/android-studio-emulator/). | ||
|
||
Start dev mode to get into an interactive development environment. | ||
|
||
```bash | ||
npm run start | ||
``` | ||
|
||
Or start iOS, Android or Web simulator directly. | ||
|
||
```bash | ||
npm run ios | ||
npm run android | ||
npm run web | ||
``` | ||
# evcc Native App | ||
|
||
Native app wrapper for evcc UI based on [react-native](https://reactnative.dev/) and [expo.dev](https://expo.dev/). It uses [UI Kitten / Eva](https://akveo.github.io/react-native-ui-kitten/) as a design system. Native parts are written in TypeScript and kept to a minimum. | ||
|
||
## iOS Beta Testing | ||
|
||
Join the beta program via TestFlight: | ||
|
||
https://testflight.apple.com/join/8Y4elMpv | ||
|
||
## Features | ||
|
||
- Onboarding | ||
- find evcc instances in local network via mDNS | ||
- add instance manually via URL | ||
- try the app using the demo instance | ||
- Full screen evcc UI | ||
- use the app in a full screen web view | ||
- UI runs in an optimized mode that respects insets (notch, ...) | ||
- better gesture support (swipe, ...) by disabling browser zoom and overscroll | ||
- Online/offline detection | ||
- app shows loading screen when instance is not reachable | ||
- automatic reconnection when instance becomes reachable again | ||
- avoids missleading situations where the app is shown but not functional | ||
- Configured URL can be changed | ||
- in offline mode | ||
- via additional top navigation entry "Server ändern" | ||
- Light and dark mode for native UI | ||
- based on system settings (not configurable) | ||
|
||
## Screenshots | ||
|
||
 | ||
|
||
## Known limitations | ||
|
||
- Only German language is supported [#2](https://github.com/evcc-io/app/issues/2) | ||
- No support for multiple instances [#3](https://github.com/evcc-io/app/issues/3) | ||
- mDNS discovery only supports HTTP [#1](https://github.com/evcc-io/app/issues/1) | ||
- No Android release yet [#4](https://github.com/evcc-io/app/issues/4) | ||
- Not (basic) auth support [#5](https://github.com/evcc-io/app/issues/5) | ||
|
||
We'll work on these in a future release. Feel free to vote 👍 to help priorization and add new feature ideas. | ||
|
||
## Development | ||
|
||
Ensure that you've Node.js and NPM installed. Then install the dependencies: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
Follow the expo instructions to run local simulators for [iOS](https://docs.expo.dev/workflow/ios-simulator/) and [Android](https://docs.expo.dev/workflow/android-studio-emulator/). | ||
|
||
Alternatively, if you use VS Code and [devcontainers](https://code.visualstudio.com/docs/devcontainers/containers), you can use the "Dev containers: Clone repository in container volume" action. This will create a devcontainer with the required toolchain and install dependencies. Wait until the startup log says "Done. Press any key to close the terminal." and check for any errors. | ||
|
||
Start dev mode to get into an interactive development environment. | ||
|
||
```bash | ||
npm run start | ||
``` | ||
|
||
Or start iOS, Android or Web simulator directly. | ||
|
||
```bash | ||
npm run ios | ||
npm run android | ||
npm run web | ||
``` | ||
|
||
## Building an Android apk | ||
|
||
To build an Android apk, in addition to the Development setup explained above, you need to: | ||
|
||
- Install the EAS CLI with `npm install --global eas-cli` | ||
- Create a (free) EAS account on https://expo.dev/ | ||
- Remove `projectId` from app.json | ||
- Run `eas build -p android --profile preview` and follow the instructions | ||
- When the build has finished, you should get a link that you can directly use to download the apk and a QR code to scan on your phone, also getting you the apk |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure why this shows the whole file as changed, but selecting the "Display the rich diff" option shows the actual changes