Skip to content

jmslynn/budget-squad

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Budget Squad

A budgeting app with categories and monthly targets.

To install all the dependencies when you first clone it:

npm install

To run a development version:

npm start

To run a production version:

npm run build

Built Using

  • Agile development methods with Jira
  • Git/Github branch based workflow
  • ESLint configured to AirBNB’s Javascript style guide
  • Documentation using JSDoc comments
  • Bug tracking with Jira
  • Redux state management
  • Responsive CSS with Bootstrap

Coming Soon:

  • Automated unit and integration testing
  • Mock REST-based backend API

Team Members

Natalie C - @natafaye Stephanie A - @asteohanie

Style Guide

This project uses the Airbnb style guide with ESLint.

To lint the project run:

npm run lint

In VS Code you can install the ESLint extension to get in-editor errors and warnings for the style guide.

For more information on the Airbnb style guide:

https://github.com/airbnb/javascript

Other Guidelines

The project is developed using Jira and Agile development methodologies.
https://www.atlassian.com/agile

All components should be functional components.

JSDoc comments should be used to document components and prop types.
https://www.inkoop.io/blog/a-guide-to-js-docs-for-react-js/

Git Workflow

This repository is contributed to through Pull Requests with either the Shared Repository or Fork and Pull model.
https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/

Feature branches should be named starting with the Jira Issue Key and then ~1-10 words describing the feature
For example: BUD-5-transaction-form-validation

Libraries Used

React
https://reactjs.org/

React Router v6
https://reactrouter.com/docs/en/v6

Redux with Redux Toolkit
https://redux.js.org/ https://redux-toolkit.js.org/

React Bootstrap
https://react-bootstrap.github.io/

Prop Types
https://www.npmjs.com/package/prop-types

Bootswatch Zephyr Theme
https://bootswatch.com/zephyr/

UUID
https://www.npmjs.com/package/uuid

Test data generated with Mockaroo
https://www.mockaroo.com/

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.1%
  • HTML 1.9%