Merge pull request #125 from theperu/main

New docs for the creation of a GitHub Page

docs/README.md

@@ -0,0 +1,69 @@
+---
+permalink: /
+---
+# **Documentation**
+> Making an open source wealth management app for everyone.
+
+## Useful links
+
+-   [Github Repo](https://github.com/RIP-Comm/sossoldi)
+-   [Discord](http://mr.rip/discord)
+-   [Design file](https://www.figma.com/file/6NyY9yqunpbU7HIkbNEAL3/Sossoldi-App?node-id=0%3A1)
+-   [UX Research](https://www.federicopozzato.it/portfolio/sossoldi-personal-finance-app)
+-   [Information architecture](https://www.figma.com/file/xjVHAaHznRW1OFAJvp8DXn/Sossoldi-App---Figjam?node-id=0%3A1)
+-   [Interface study](https://www.notion.so/Sossoldi-Personal-finance-app-dd37eb9cbb2c44e59dd74f85e843e865)
+-   [Set up guide](setup.md)
+
+## About
+
+**Sossoldi** is a free and open source wealth management / personal finance / Net Worth tracking app, made with Flutter.
+
+
+<div>
+    <img src="./assets/sossoldi project cover.jpg" width="1000" alt="Sossoldi icon">
+</div>
+
+## ❓ What problem we are solving & why
+
+[Mr. Rip](https://retireinprogress.com/) is a blogger that has a [spreadsheet](https://docs.google.com/spreadsheets/d/1ilL6rBdzIQ6yRotqOKLUKI7KXFxu5_cZ5FQgdYTSHJk/edit#gid=138629885) in which he tracks his net worth. Sossoldi is a Mobile + Desktop app that aims at replacing that spreadsheet and make it easier for everyone to track their net worth even if they are not as skilled with Google sheets or Excel.
+
+The app is being developed using the [Flutter](https://docs.flutter.dev/get-started/install) framework which makes it possible to have one codebase for different platforms (Android, iOS, Windows, macOS, Linux). We are currently working on a beta which hopefully will be out soon.
+
+## This app is for you if you want to...
+
+-   📈 Track their net worth
+-   💸 Track your expenses to better understand where they are spending their money
+-   👀 Keep track of your investments
+-   🪦 Keep everything in one place like Mr. Rip
+
+What features do we want to implement?
+-   💸 Track expenses (even recurrent ones)
+-   🏦 Track different bank accounts
+-   📊 Graphs, statistics and reports
+-   💻 All data are stored locally (with the option to share it in different platforms)
+-   👀 Track investments: Stocks, Bonds, Crypto, Private equity
+-   💶 Track taxes
+-   💴 Net worth on different currencies
+-   ↔️ Import/export data
+-   🔗 Link bank accounts that support the OpenBanking PSD2 API
+-   🤓 Advanced onboarding
+
+<div align="center">
+<img src="./assets/Sossoldi-portfolio-card-image.png" width="500" alt="Sossoldi icon">
+</div>
+
+## Phase 1 (Ongoing)
+We will not build the complete app all at once. We will start from the basic features and then we will move onto the others.
+Phase 1 will be completed when the following features will be ready:
+-   💸 Expenses (even recurrent ones) tracker
+-   🤑 Income tracker
+-   ⚖️ Bank accounts balance (without the use of API)
+-   📊 Basic stats
+-   📱 Data stored only locally
+
+The pages that will be implemented are:
+-   Dashboard
+-   Movements page
+-   Basic settings
+-   Basic onboarding
+

docs/setup.md

@@ -0,0 +1,36 @@
+# Setup Guide
+
+## Step 1: Install Git
+
+Download and install Git from [https://git-scm.com/](https://git-scm.com/).
+
+## Step 2: Install Flutter
+
+1. Download the Flutter SDK from [https://flutter.dev/docs/get-started/install](https://flutter.dev/docs/get-started/install).
+2. Extract the downloaded archive to a location on your machine.
+3. Add the Flutter `bin` directory to your system's `PATH` variable.
+
+## Step 3: Set Up an IDE
+
+Choose one of the following:
+
+### Using Visual Studio Code:
+
+1. Download and install Visual Studio Code from [https://code.visualstudio.com/](https://code.visualstudio.com/).
+2. Install the Flutter and Dart extensions.
+
+### Using IntelliJ IDEA or Android Studio:
+
+1. Download and install IntelliJ IDEA or Android Studio.
+2. Install the Flutter and Dart plugins.
+
+## Step 4: Fork the repository
+
+This is very simple, just go to the Sossoldi repository on GitHub and click on the “Fork” on the top right corner. By doing this you will create a copy of the repository on your account and it will allow you to make changes without affecting the main repository.
+
+## (Optional) Download GitHub Desktop
+
+If you are unfamiliar with Git you might want to use GitHub Desktop. 
+1. Go to this link and download GitHub Desktop. With this it will be easier to manage and submit the changes that you will do. After the download, set up your account.
+2. Now comeback to your repository on GitHub and click on Code -> Open with GitHub Desktop
+3. This will open GitHub Desktop and it should ask you to add the path in which you want to save the folder with the project. Then click on clone.