- 📖 Table of Contents
- 📍 Overview
- 📦 Features
- 📂 Repository Structure
- ⚙️ Modules
- 🚀 Getting Started
- 🤝 Contributing
- 📄 License
The repository contains a simple console-based financial analysis tool. It takes a dataset of monthly profits and losses, and calculates various metrics such as total number of months, total profit/loss, average change in profit/loss, and identifies the months with the highest increase and decrease in profit/loss. Results are displayed in the console.
| Feature | Description | |
|---|---|---|
| ⚙️ | Architecture | The codebase follows a simple structure with an HTML file (index.html) serving as the user interface and a JavaScript file (index.js) handling data processing. |
| 🔗 | Dependencies | The codebase relies on HTML and JavaScript as dependencies to function. |
| 🧩 | Modularity | The codebase is not modular, primarily consisting of two files working together. |
| 🧪 | Testing | The codebase lacks testing strategies and tools. |
| ⚡️ | Performance | Performance analysis is not applicable as the codebase mainly deals with calculations and does not have heavy computational or data processing requirements. |
| 🔐 | Security | No security measures are implemented in the codebase. |
| 🔀 | Version Control | The repository uses Git for version control. |
| 🔌 | Integrations | The codebase does not have any integrations. |
| 📶 | Scalability | The codebase lacks scalability considerations, being a small script primarily focused on financial analysis. |
└── Console-Finances/
├── index.html
└── index.js
Root
| File | Summary |
|---|---|
| index.html | The code is a basic HTML file with an associated JavaScript file. The HTML file contains a title and a heading, instructing the user to open the console. The JavaScript file is included in the HTML file and will be executed when the page loads. |
| index.js | The code performs financial analysis on a dataset of monthly profits and losses. It calculates the total number of months, the sum of all profits and losses, the average change in profit/loss over the given period, and identifies the months with the greatest increase and decrease in profit/loss. The results are then printed to the console. |
- Clone the Console-Finances repository:
git clone https://github.com/pmAdriaan/Console-Finances- Change to the project directory:
cd Console-Finances- Install the dependencies:
► N/A► 1. Open index.html with Live Server plugin in VS Code;
► 2. Open DevTools in your browser and check the console.
Contributions are welcome! Here are several ways you can contribute:
- Submit Pull Requests: Review open PRs, and submit your own PRs.
- Join the Discussions: Share your insights, provide feedback, or ask questions.
- Report Issues: Submit bugs found or log feature requests for PMADRIAAN.
Click to expand
- Fork the Repository: Start by forking the project repository to your GitHub account.
- Clone Locally: Clone the forked repository to your local machine using a Git client.
git clone <your-forked-repo-url>
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear and concise message describing your updates.
git commit -m 'Implemented new feature x.' - Push to GitHub: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
Copyright © 2023 Mihai-Adrian P.
This project is licensed under the ℹ️ MIT-License. See the MIT License file for additional info.