103 lines
2.4 KiB
Markdown
Executable File
103 lines
2.4 KiB
Markdown
Executable File
# Retirement Calculator
|
|
## 2800-202510-BBY14
|
|
|
|
## Overview
|
|
|
|
Retirement Calculator - The goal of the application is to help users manage and track their financial progress in a way that reflects real life. Instead of just acting as a calculator, the app functions as a dynamic tracker. It shows the user a percentage of how much of their goal has been achieved and compares their actual performance to their planned targets.
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
- Do calculator stuff
|
|
|
|
---
|
|
|
|
## Technologies Used
|
|
|
|
Example:
|
|
- **Frontend**: HTML, CSS, JavaScript
|
|
- **Backend**: Express.js
|
|
- **Database**: MongoDB
|
|
|
|
---
|
|
|
|
## Usage
|
|
|
|
1. **Clone the repository:**
|
|
```bash
|
|
git clone https://github.com/JoaquinPar/2800-202510-BBY14.git
|
|
cd 2800-202510-BBY14
|
|
```
|
|
|
|
2. **Install dependencies:**
|
|
```bash
|
|
npm install
|
|
```
|
|
This will install Express, express-session, EJS, dotenv, and any other required packages listed in `package.json`.
|
|
|
|
3. **Create and configure the environment file:**
|
|
- Create a file named `.env` in the root directory of the project.
|
|
- Add the necessary environment variables to this file.
|
|
|
|
4. **Run the application:**
|
|
```bash
|
|
node app.js
|
|
```
|
|
The application should now be running, typically on `http://localhost:3000` (or the port specified in your `.env` file).
|
|
|
|
---
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
retirementCalculator/
|
|
├── src/
|
|
| ├── auth/
|
|
| ├── database/
|
|
│ ├── public/
|
|
│ │ ├── images/
|
|
│ │ ├── scripts/
|
|
│ │ └── svgs/
|
|
| |
|
|
│ ├── router/
|
|
│ ├── utils/
|
|
│ └── views/
|
|
│ └── partials/
|
|
│
|
|
├── .env.example
|
|
├── .gitignore
|
|
├── app.js
|
|
├── CONTRIBUTING.md
|
|
├── LICENSE
|
|
├── package-lock.json
|
|
├── package.json
|
|
└── README.md
|
|
```
|
|
|
|
---
|
|
|
|
## Contributors
|
|
- **[Braeden Sowinski](https://github.com/SowinskiBraeden)** - BCIT CST Student with a passion for back-end development.
|
|
- **[Joaquin Paredes](https://github.com/JoaquinPar)** - BCIT CST Student with the aspiration of becoming a game developer in the future.
|
|
- **[Nicolas Agostini](https://github.com/nicoagostini)** - BCIT CST Student with a passion for technology and AI.
|
|
- **[Mitchell Schaeffer](https://github.com/knighthawk4227)** - BCIT CST Student with a passion for technology.
|
|
|
|
---
|
|
## more details to come...
|
|
|
|
## Limitations and Future Work
|
|
### Limitations
|
|
|
|
- None
|
|
|
|
### Future Work
|
|
|
|
- All work
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
[MIT LICENSE](/LICENSE)
|