Skip to content

Latest commit

 

History

History
117 lines (82 loc) · 3.17 KB

README.md

File metadata and controls

117 lines (82 loc) · 3.17 KB

Credutally Credit Platform

The Secure Credit Granting and Investing Platform

   ____              _       _        _ _       
  / ___|_ __ ___  __| |_   _| |_ __ _| | |_   _ 
 | |   | '__/ _ \/ _` | | | | __/ _` | | | | | |
 | |___| | |  __/ (_| | |_| | || (_| | | | |_| |
  \____|_|  \___|\__,_|\__,_|\__\__,_|_|_|\__, |
                                          |___/

Credutally is a secure credit-granting application built with Svelte. It provides an intuitive interface for users to calculate loan repayments and manage their credit securely.

Svelte](https://svelte.dev/)

Credutally Features

  • This app is currently in develoment.
    • currently the register and login features are being built -

Installation

Credutally requires Node.js v16+ to run.

Install the dependencies and devDependencies and start the server.

cd credutally
npm i
node app

For production environments...

npm install --production
NODE_ENV=production node app

How to Run the App

Prerequisites

  • Currently the app is woking on node 18.13 and this version should be used
  • Ensure you have Node.js version 18.13.0 installed. You can manage your Node.js versions using nvm (Node Version Manager).

Steps to Run ( the client app)

   git clone gat@github.com/aducci/credutally.git
   cd credutally
   nvm use 18.13.0 (need to setup NVM)
   npm install
   npm run dev

Steps to Run ( the server app)

  • inclued in the folder is the nodejs server.js file, this exposes all the API routes needed for the app. to run:
  cd server
  npm install
  node server.js

how to setup nvm

   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
   
   export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
   
   source ~/.bashrc  # or source ~/.zshrc, source ~/.profile, etc.
   nvm install 18.13.0
   nvm alias default 18.13.0
   nvm use 18.13.0

Why Svelte?

Credutally is built using Svelte, a modern JavaScript framework for building user interfaces. Here’s why we chose Svelte:

  • Reactivity: Svelte makes it easy to create highly reactive interfaces with minimal code.
  • Performance: Svelte compiles your code to highly optimized vanilla JavaScript at build time, resulting in fast runtime performance.
  • Simplicity: The syntax and concepts in Svelte are simple and intuitive, making the development process enjoyable and straightforward.
  • No Virtual DOM: Unlike other frameworks, Svelte updates the DOM directly, leading to better performance and less overhead.

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

Coding Practices.

Cloning the repo: you must setup the ssl pairing and clone git using ssl. git clone gat@github.com/aducci/credutally.git

Commit to mainBranch with

git status to see what will be synced.
git add .
git commit -m "MESSAGE"
git push -u origin master

License

This project is licensed under the MIT License.