Skip to content

Commit

Permalink
docs(readme): fix & improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Xenepix committed Jan 5, 2024
1 parent 9a781fd commit 149a345
Show file tree
Hide file tree
Showing 9 changed files with 122 additions and 36 deletions.
84 changes: 48 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
<h1 align="center">
<img src="https://github.com/napse-invest/Napse/blob/main/desktop-app/renderer/public/images/napse_white.svg" width=500/>
</h1><br>

<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>
<img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/napse-investment/40fac957532fe3b731c99067467de842/raw/napse-developer-toolkit-coverage.json" alt="Coverage" />
</a>
Expand All @@ -20,49 +24,57 @@

<p align="center">
<a href="#napse-developer-toolkit"><strong>Napse Developer Toolkit</strong></a> ·
<a href="#development-environment"><strong>Development environment</strong></a> .
<a href="#cli"><strong>CLI</strong></a> .
<a href="#setup-local-environment"><strong>Setup local environment</strong></a> .
<a href="#run-project-with-docker"><strong>Docker</strong></a> .
<a href="#useful-commands"><strong>Useful commands</strong></a>
</p>
<br/>

## Napse Developer Toolkit
# Napse Developer Toolkit
All you need to push the customisation of your Napse services to the next level.

## Development environment

### Setup local environment
## Setup local environment

Local environment is use for your IDE, but it's not use to run napse-dtk. See [Run project with docker](#run-project-with-docker) for more information.

Run the setup script to fully setup your local environment:
- Unix \
```source setup-unix.sh```

- Windows (PowerShell terminal as administrator)\
```.\setup-windows.ps1```

### Run project with docker

- Start docker in development environment \
```docker-compose -f ./backend/docker/development.yml up --build -d```
To setup your local environment:
```bash
make setup
```

- Start docker in development as production environment \
```docker-compose -f ./backend/docker/dev_as_prod.yml up --build -d```


## CLI

...
## Run project with docker

- Start:
```bash
make up
```

## Useful commands

- Start docker \
```docker-compose -f ./backend/docker/<yml file> up --build -d```

- Stop docker \
```docker-compose -f ./backend/docker/<yml file> down```

- Enter in the django container \
```docker exec -it napse_dtk_dev_django /bin/bash```
- Build:
```bash
make build
```

- Stop:
```bash
make down
```

- Run tests:
```bash
make test
```

- Run tests with coverage:
```bash
make coverage
# or
make coverage-open
```

- lightstream:
```bash
make litestream
```
5 changes: 5 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Thank you for your interest in contributing to Napse Developer ToolKit !

The Napse Developer ToolKit is still in early stage.

That's why we're not yet accepting contributions, but it shouldn't be long now!
8 changes: 8 additions & 0 deletions docs/SECURITY.md
Original file line number Diff line number Diff line change
@@ -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 `[email protected]` or contact an administrator on the official discord server.

Thanks you in advance.

The Napse Team
44 changes: 44 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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>
1 change: 1 addition & 0 deletions docs/theme/assets/napse_invest_logo_black.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/theme/assets/napse_invest_logo_white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 149a345

Please sign in to comment.