Skip to content

TeoTodorov16/Finance-App

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

$teward (a personal finance app)

A category based budget built with react.js and firebase

'Product' Description

Login or signup to to set a monthly category / envelope budget, track spending, allocate funds, transfer, deduct, and deposit.

Project Objective

// flesh this out...

Get Set Up (for devlopers that are forking or cloning)

Create a .env.development.local at the top level of your repository (with / next to package.json), and assign your credentials to these variable names. You'll need to create your own firebase account for your own credential keys (unless your a collaborator).

REACT_APP_FIREBASE_API_KEY = placeholder
REACT_APP_FIREBASE_AUTH_DOMAIN = placeholder
REACT_APP_FIREBASE_PROJECT_ID = placeholder
REACT_APP_FIREBASE_STORAGE_BUCKET = placeholder
REACT_APP_FIREBASE_MESSAGING_SENDER_ID = placeholder
REACT_APP_FIREBASE_APP_ID = placeholder

This is why the config object in this projects firebase.js looks like this.

const config = {
    apiKey: process.env.REACT_APP_FIREBASE_API_KEY,
    authDomain: process.env.REACT_APP_FIREBASE_AUTH_DOMAIN,
    projectId: process.env.REACT_APP_FIREBASE_PROJECT_ID,
    storageBucket: process.env.REACT_APP_FIREBASE_STORAGE_BUCKET,
    messagingSenderId: process.env.REACT_APP_FIREBASE_MESSAGING_SENDER_ID,
    appId: process.env.REACT_APP_FIREBASE_APP_ID
};

Before you are able to run any scripts to start the app in local host (or otherwise) you'll need to run npm i env-cmd (see below).

Scripts

Once you have installed the env-cmd package, run npm run sDev for a custom react scripts start. This custom script employs env-cmd to force the particular .env in the package.json scripts. sDev starts the development environment using .env.development.local.

Similarly, use npm run bDev to build the project using the development environment. This bundles the project in servable build files in the ./build directory.

Memos / notes

Overall

A Word on React

This project was bootstrapped with Create React App.

While the initial react-app boiler-plate comes with testing and scripts I've paired things down to whats needed. If you want to learn more about react and it's defaults checkout their official docs.

About

A Personal Finance App Collaboration

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors