Skip to content

Latest commit

 

History

History
226 lines (161 loc) · 7.78 KB

README.md

File metadata and controls

226 lines (161 loc) · 7.78 KB

Service stopped from 22. march 2024

image

📔 Sbanken forbruk - Table of contents

🌟 About the Project

This application lets you view your spending and transactions in a summarized view. Some transactions are categorized and can be viewed under the Kategorier tab. You are also able to go back and forward in time by selecting a time range.

📷 Screenshots

screenshot

👾 Tech Stack

Client
Devops

🎯 Features

Home page

Basic overview of account, recent transactions, grouped transactions image

Lister

View an overview of grouped transactions and recent transactions in gridview image

Kategorier

View categorized transactions image

Time range selector

  • Allows the user to navigate to previous and next month by using chevrons
  • Allows the user to select a time range by clicking on the calendar
  • You cannot move to a date greater than yesterday image image

🎨 Color Reference

Color Hex
Primary Color #FFFFFF --color_a_100
Secondary Color #262342 --color_b_100
Accent Color #32fcb3 --color_c_100
Text Color #262342 or #FFFFFF

🧰 Getting Started

‼️ Prerequisites

This project uses NPM as package manager https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

⚙️ Installation

Install my-project with npm

  mpm i

🧪 Running Tests

Tests have not been prioritized in this application, however i did add a few minor test cases for fun

To run tests, run the following command

  npm run test

🏃 Run Locally

Clone the project

  git clone https://github.com/StanlyLife/Sbanken

Install dependencies

  npm i

Start the server

  npm run start

👀 Usage

You can login using your own API Secret and API key or you can click test to login using test data. With test data you are unable to select dates as the test data only provides data for 1 month.

image

Sbanken developer portal (utvikler portal)

Api Key

  • Go to the developer portal
  • Find your key as displayed in the image (The api key shown is not my actual key) image

Api Secret

  • Go to the developer portal
  • Order new password image
  • Fill out the information image -Copy key

🧭 Roadmap

  • Add overview/home
  • Add grid/view
  • Add categories
  • Add login and test data
  • Refactor code
  • Clean up code
  • Performance improvements

Note: This app was intended to be a lot smaller than it currently is. Due to this reason i picket up a lot of technical debt. The technical debt has not been resolved and i do not plan on continuing work on this application until Sbanken improves or extends thei API.

👋 Contributing

Contributions are always welcome!

⚠️ License

Licence type: MIT

Copyright 2022 Stian Håve

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

🤝 Contact

Linkedin Badge - Stian Håve

Acknowledgements

Sbanken API: https://publicapi.sbanken.no/openapi/apibeta/index.html