From 149a3451d2d0ca20067759b2ae9d686da891002b Mon Sep 17 00:00:00 2001 From: Xenepix Date: Fri, 5 Jan 2024 21:36:46 +0100 Subject: [PATCH] docs(readme): fix & improve readme --- README.md | 84 +++++++++++-------- docs/CONTRIBUTING.md | 5 ++ docs/SECURITY.md | 8 ++ docs/index.md | 44 ++++++++++ docs/theme/assets/napse_invest_logo_black.svg | 1 + docs/theme/assets/napse_invest_logo_white.svg | 1 + docs/theme/assets/napse_logo_black.svg | 9 ++ docs/theme/assets/napse_logo_white.svg | 1 + docs/theme/assets/stylesheets/extra.css | 5 ++ 9 files changed, 122 insertions(+), 36 deletions(-) create mode 100644 docs/CONTRIBUTING.md create mode 100644 docs/SECURITY.md create mode 100644 docs/index.md create mode 100644 docs/theme/assets/napse_invest_logo_black.svg create mode 100644 docs/theme/assets/napse_invest_logo_white.svg create mode 100644 docs/theme/assets/napse_logo_black.svg create mode 100644 docs/theme/assets/napse_logo_white.svg create mode 100644 docs/theme/assets/stylesheets/extra.css diff --git a/README.md b/README.md index ad0e8b5..8f6c723 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ -

- -


- +
+ + + + Napse's logo + +
+ +

- Coverage @@ -20,49 +24,57 @@

Napse Developer Toolkit ยท - Development environment . - CLI . + Setup local environment . + Docker . Useful commands


-## 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/ up --build -d``` - -- Stop docker \ - ```docker-compose -f ./backend/docker/ 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 +``` \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..b2cdc15 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -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! \ No newline at end of file diff --git a/docs/SECURITY.md b/docs/SECURITY.md new file mode 100644 index 0000000..2a5e840 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..d73bf99 --- /dev/null +++ b/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} +

+ +# 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. + + + + +

+
+ +- :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 + + + +
\ No newline at end of file diff --git a/docs/theme/assets/napse_invest_logo_black.svg b/docs/theme/assets/napse_invest_logo_black.svg new file mode 100644 index 0000000..be754fb --- /dev/null +++ b/docs/theme/assets/napse_invest_logo_black.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/theme/assets/napse_invest_logo_white.svg b/docs/theme/assets/napse_invest_logo_white.svg new file mode 100644 index 0000000..05e2b61 --- /dev/null +++ b/docs/theme/assets/napse_invest_logo_white.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/theme/assets/napse_logo_black.svg b/docs/theme/assets/napse_logo_black.svg new file mode 100644 index 0000000..3b736ae --- /dev/null +++ b/docs/theme/assets/napse_logo_black.svg @@ -0,0 +1,9 @@ + + + + + + + \ No newline at end of file diff --git a/docs/theme/assets/napse_logo_white.svg b/docs/theme/assets/napse_logo_white.svg new file mode 100644 index 0000000..414f433 --- /dev/null +++ b/docs/theme/assets/napse_logo_white.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/theme/assets/stylesheets/extra.css b/docs/theme/assets/stylesheets/extra.css new file mode 100644 index 0000000..f4e449d --- /dev/null +++ b/docs/theme/assets/stylesheets/extra.css @@ -0,0 +1,5 @@ + +.center { + display: block; + margin: 0 auto; +} \ No newline at end of file