zhaluza / espp-budget-app

ESPP Budget App

A tool to help you calculate how much you save while taking part in your organization's Employee Stock Purchase Plan (ESPP).

To demo a live version of this app, click here.

Table of Contents

• About the Project
  • Built With
  • Tested With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

### Built With

• React
• Redux
• Sass
• React Router
• Node
• Express

Tested With

• Jest
• Enzyme
• Redux Mock Store

Getting Started

Prerequisites

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/zhaluza/espp-budget-app.git

3. Install NPM packages

npm i

4. Set up your own OAuth App on Github.

5. For Homepage URL, enter http://localhost:3000.

6. For Authorization callback URL, enter http://localhost:3000/redirect.

7. Inside the root directory of your cloned repo, create a file called .env.

8. Enter the following credentials from your new Github OAuth app into the file like so:

CLIENT_ID=insert your client id here
CLIENT_SECRET=enter your client secret here

Usage

Boot up the app in dev mode by running the following script:

npm run dev

Want to run the app in production mode? Start up the server with the following command:

npm start

You can now access the app at http://localhost:3000 in your browser.

Testing

The app's current test coverage consists of unit tests for each of the three main components. Run tests with the following script:

npm test

License

Distributed under the ISC License.