-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dev' into dependabot/npm_and_yarn/desktop-app/dev/types…
…/node-20.8.6
- Loading branch information
Showing
124 changed files
with
14,808 additions
and
1,645 deletions.
There are no files selected for viewing
This file contains 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,38 @@ | ||
name: Deploy to Github Releases | ||
|
||
on: | ||
release: | ||
types: [published] | ||
|
||
|
||
|
||
jobs: | ||
release: | ||
runs-on: ${{ matrix.os }} | ||
|
||
strategy: | ||
matrix: | ||
os: [macos-latest, ubuntu-latest, windows-latest] | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
persist-credentials: false | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: 18.x | ||
|
||
|
||
- name: Build/release Electron app | ||
uses: samuelmeuli/action-electron-builder@v1 | ||
with: | ||
# GitHub token, automatically provided to the action | ||
# (No need to define this secret in the repo settings) | ||
github_token: ${{ secrets.github_token }} | ||
|
||
# If the commit is tagged with a version (e.g. "v1.0.0"), | ||
# release the app after building | ||
release: ${{ startsWith(github.ref, 'refs/tags/v') }} |
This file contains 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,25 @@ | ||
name: mkdocs | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
deply-docs: | ||
name: Deploy docs | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout main | ||
uses: actions/checkout@v4 | ||
|
||
- name: Deploy docs | ||
uses: mhausenblas/mkdocs-deploy-gh-pages@master | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
CONFIG_FILE: mkdocs.yml | ||
REQUIREMENTS: docs/setup-docs/requirements.txt | ||
|
This file contains 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
This file contains 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
This file contains 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
This file contains 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,73 +1,34 @@ | ||
# Napse | ||
|
||
The best open source investment software. | ||
|
||
### Runing the graphic user interface | ||
|
||
The GUI is a desktop app. It is made using Electron, React and Typescript. | ||
You can find it in the desktop-app folder. | ||
Here are the steps to run it (if you already have nvm, node and yarn installed, go to the step 4 directly): | ||
|
||
1. **Install nvm** | ||
|
||
To install nvm, download and install the nvm script from the project's GitHub page: | ||
|
||
```shell | ||
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash | ||
``` | ||
|
||
After installing nvm, close your terminal and open a new one. Verify the installation by checking the version of nvm: | ||
|
||
```shell | ||
nvm --version | ||
``` | ||
|
||
2. **Install Node.js** | ||
|
||
Now, you can install Node.js. The following command installs Node.js latest version : | ||
<div align="center"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="docs/theme/assets/napse_invest_logo_white.svg"> | ||
<source media="(prefers-color-scheme: light)" srcset="docs/theme/assets/napse_invest_logo_black.svg"> | ||
<img alt="Napse's logo" src="" width=500> | ||
</picture> | ||
</div> | ||
|
||
|
||
<br> | ||
<p align="center"> | ||
<a href="https://twitter.com/NapseInvest"> | ||
<img src="https://img.shields.io/twitter/follow/NapseInvest?style=flat&label=%40NapseInvest&logo=twitter&color=0bf&logoColor=fff" alt="Twitter" /> | ||
</a> | ||
<a> | ||
<img src="https://img.shields.io/github/v/release/napse-invest/Napse" alt="Release" /> | ||
</a> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="#Napse"><strong>Napse</strong></a> · | ||
<a href="#documentation"><strong>Documentation</strong></a> | ||
</p> | ||
<br/> | ||
|
||
```shell | ||
nvm install --lts | ||
``` | ||
|
||
3. **Install yarn** | ||
|
||
Yarn is a Node package manager. Install it by running these commands | ||
|
||
```shell | ||
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - | ||
``` | ||
|
||
```shell | ||
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list | ||
``` | ||
|
||
```shell | ||
sudo apt update | ||
``` | ||
|
||
```shell | ||
sudo apt install yarn | ||
``` | ||
|
||
4. **Install dependencies** | ||
|
||
Start by moving to the desktop-app folder | ||
|
||
```shell | ||
cd desktop-app | ||
``` | ||
|
||
Then use yarn to download all dependencies | ||
# Napse | ||
|
||
```shell | ||
yarn | ||
``` | ||
Napse is the future of open source investment. It connects seamlessly to exchanges and manages the money entrusted to it with trading bots. | ||
|
||
5. **Run the client** | ||
Napse is a desktop application compatible with all platforms. [Django-napse](https://github.com/napse-invest/django-napse) is the heart of the system, and Napse enables efficient deployment, operation and performance visualization. | ||
|
||
Use this yarn command to run client in dev mode | ||
# Documentation | ||
|
||
```shell | ||
yarn dev | ||
``` | ||
You can find the documentation [here](https://napse-invest.github.io/Napse/). |
This file was deleted.
Oops, something went wrong.
This file contains 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 |
---|---|---|
|
@@ -4,4 +4,5 @@ node_modules | |
/app | ||
dist | ||
next-env.d.ts | ||
out/ | ||
out/ | ||
secrets.json |
This file contains 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
Oops, something went wrong.