Merge pull request #167 from napse-invest/docs

Docs

.github/workflows/mkdocs.yml

@@ -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@v2
+
+      - 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
+

README.md

@@ -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/).

docs/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+Thank you for your interest in contributing to Napse
+
+Napse is still in early stage.
+
+We want the foundations of Napse to be in place so that the community can build on them. 
+
+That's why we're not yet accepting contributions, but it shouldn't be long now!

docs/SECURITY.md

@@ -0,0 +1,8 @@
+# Security
+
+If you discover a security issue, no matter how big or small, please **do not open an issue or a pull request** !
+Contact us asap at `napse.invest@gmail.com` or contact an administrator on the official discord server.
+
+Thanks you in advance.
+
+The Napse Team

docs/index.md

@@ -0,0 +1,44 @@
+![Napse logo](theme/assets/napse_invest_logo_black.svg#only-light){ width="500" : .center}
+![Napse logo](theme/assets/napse_invest_logo_white.svg#only-dark){ width="500" : .center}
+<br></br>
+
+# Welcome to Napse Documentation
+
+
+Napse is the future of open source investment. It connects seamlessly to exchanges and manages the money entrusted to it with trading bots.
+
+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.
+
+
+
+
+<br></br>
+<div class="grid cards" markdown>
+
+-   :material-lightning-bolt:{ .lg .middle } **Powerfull**
+
+    ---
+
+    Simplifies money management and performance visualization
+
+-   :octicons-light-bulb-16:{ .lg .middle } **Environment**
+
+    ---
+
+    Napse lets you build and configure your own trading bots
+
+-   :simple-github:{ .lg .middle } **Open source**
+
+    ---
+
+    Napse is open source, under an MIT license
+
+-   :material-crop-free:{ .lg .middle } **Tranparency**
+
+    ---
+
+    Seamlessly integrated from end to end to make your life easier
+
+
+
+</div>

docs/setup-docs/requirements.txt

@@ -0,0 +1,3 @@
+mkdocs-material==9.5.3             # https://github.com/squidfunk/mkdocs-material
+pygments==2.17.2                    # https://github.com/pygments/pygments
+watchfiles==0.21.0                  # https://github.com/samuelcolvin/watchfiles