MyBudget Web

Table of contents

• MyBudget Web
  • Table of contents
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
    • Serving the app
    • Unit teststing
    • Building a distribution version
  • Infrastructure
    • Initialize Terraform
    • Plan your Terraform changes
    • Apply your Terraform changes
  • Deploy S3
  • Contributing
  • License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

This project requires NodeJS (at least version 8) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ node --version
v10.1.0

$ npm --version
6.0.1

Installation

Start with cloning this repo on your local machine:

$ git clone git@github.com:ItalianCoders/myBudget-web-frontend.git
$ cd myBudget-web-frontend

Then install all the Node dependencies usin npm or Yarn

$ npm install
# Or using Yarn for a faster installation
$ yarn

Usage

Serving the app

$ npm start

Unit teststing

$ npm test

Building a distribution version

$ npm run build

Infrastructure

This project uses Terraform to create a mubudget.com S3 bucket into your AWS account. Make sure you have your AWS credentials available in your machine and Terraform installed.

Initialize Terraform

$ terraform init terraform/environments

Plan your Terraform changes

$ terraform plan terraform/environments

Apply your Terraform changes

$ terraform apply terraform/environments

This will create a mubudget.com S3 bucket and a mubudget-s3-upload user with writing access to your new S3 bucket only.

Deploy S3

$ make deploy

This will build a new distribution version of the project and sync the dist/ folder with the S3 bucket.

This task will create a distribution version of the project inside your local dist/my-budget-it folder

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request 😎

License

MIT License © ItalianCoders