fix/README file folder structure updated

update/landing page and aboutUs page created
README updated with instructions
2025-05-02 01:52:05 -07:00 · 2025-05-02 01:39:33 -07:00 · 2025-05-01 19:31:07 -07:00 · 2025-05-01 19:25:57 -07:00 · 2025-05-01 19:24:18 -07:00 · 2025-04-30 17:17:00 -07:00
9 changed files with 220 additions and 14 deletions
@@ -1,2 +1,4 @@
 mongoURI='mongodb://localhost:27017/'
 database='nameOfDatabase'
+PORT=8000
+
@@ -24,11 +24,27 @@ Example:

 ## Usage

-***Please check back later.***
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/JoaquinPar/2800-202510-BBY14.git
+   cd 2800-202510-BBY14
+   ```

-1. ...
-2. ...
-3. ...
+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).

 ---

@@ -37,14 +53,11 @@ Example:
 ```
 retirementCalculator/
 ├── src/
-|   ├── app.js
 │   ├── views/
-│   ├── public/
-|   |    ├── css/
-|   |    ├── icons/
-|   |    ├── images/
-|   |    └── scripts/
-│   └── util/
+|   ├── css/
+|   ├── images/
+|   └── scripts/
+├── app.js
 ├── .env.example
 ├── .gitignore
 ├── LICENSE
@@ -62,6 +75,7 @@ retirementCalculator/
 - **[Mitchell Schaeffer](https://github.com/knighthawk4227)** - BCIT CST Student with a passion for technology.

 ---
+## more details to come...

 ## Limitations and Future Work
 ### Limitations
@@ -0,0 +1,12 @@
+<html>
+ <body>
+  Team Name: BBY-14
+  Team Members:
+  <ul>
+    <li> Joaquin Paredes </li>
+    <li> Nicolas Agostini </li>
+    <li> Mitchell Schaeffer </li>
+    <li> Braeden Sowinski </li>
+  </ul>
+ </body>
+</html>
@@ -1,11 +1,29 @@
 const express = require('express');
 const path = require('path');
+const dotenv = require('dotenv');
+
+dotenv.config();

 const app = express();
-const port = 8000;
+
+const port = process.env.PORT || 3000;

 app.set('view engine', 'ejs');
-app.set('views',path.join(__dirname, 'views'));
+app.set('views',path.join(__dirname, 'src/views'));
+
+
+app.use(express.urlencoded({ extended: true }));
+
+
+/*
+STATIC ROUTINGS
+*/
+
+app.use("/scripts", express.static("./src/scripts"));
+app.use("/css", express.static("./src/css"));
+app.use("/images", express.static("./src/images"));
+app.use("/views", express.static("./src/views"));
+

 /*
 ROUTINGS
@@ -15,6 +33,10 @@ app.get('/', (req, res) => {
    res.render('index');
 });

+app.get('/landing', (req, res) => {
+    res.render('landing');
+});
+
 app.get('/signup', (req, res) => {
    res.render('signup');
 });
@@ -9,6 +9,7 @@
      "version": "0.1.0",
      "license": "MIT",
      "dependencies": {
+        "dotenv": "^16.5.0",
        "ejs": "^3.1.10",
        "express": "^5.1.0"
      },
@@ -315,6 +316,17 @@
        "node": ">= 0.8"
      }
    },
+    "node_modules/dotenv": {
+      "version": "16.5.0",
+      "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.5.0.tgz",
+      "integrity": "sha512-m/C+AwOAr9/W1UOIZUo232ejMNnJAJtYQjUbHoNTBNTJSvqzzDh7vnrei3o3r3m9blf6ZoDkvcw0VmozNRFJxg==",
+      "engines": {
+        "node": ">=12"
+      },
+      "funding": {
+        "url": "https://dotenvx.com"
+      }
+    },
    "node_modules/dunder-proto": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz",
@@ -339,7 +351,6 @@
      "version": "3.1.10",
      "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz",
      "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==",
-      "license": "Apache-2.0",
      "dependencies": {
        "jake": "^10.8.5"
      },
@@ -18,6 +18,7 @@
  },
  "homepage": "https://github.com/JoaquinPar/2800-202510-BBY14#readme",
  "dependencies": {
+    "dotenv": "^16.5.0",
    "ejs": "^3.1.10",
    "express": "^5.1.0"
  },
@@ -0,0 +1,80 @@
+<html>
+    <head>
+        <title>RCalculator</title>
+        <link rel="icon" href="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/rekor.png">
+        <link href="https://cdn.jsdelivr.net/npm/tailwindcss@3.3.2/dist/tailwind.min.css" rel="stylesheet">
+    </head>
+    <body class="bg-white dark:bg-gray-900">
+        <header>
+            <nav class="bg-gray-50 dark:bg-gray-800 border-b border-gray-200 dark:border-gray-700">
+                <div class="max-w-screen-xl flex flex-wrap items-center justify-between mx-auto p-4">
+                    <a href="#" class="flex items-center space-x-3 rtl:space-x-reverse">
+                        <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/rekor.png" class="h-8" alt="Flowbite Logo" />
+                        <span class="self-center text-2xl font-semibold whitespace-nowrap dark:text-white">RCalculator</span>
+                    </a>
+                    <button data-collapse-toggle="navbar-solid-bg" type="button" class="inline-flex items-center p-2 w-10 h-10 justify-center text-sm text-gray-500 rounded-lg md:hidden hover:bg-gray-100 focus:outline-none focus:ring-2 focus:ring-gray-200 dark:text-gray-400 dark:hover:bg-gray-700 dark:focus:ring-gray-600" aria-controls="navbar-solid-bg" aria-expanded="false">
+                        <span class="sr-only">Open main menu</span>
+                        <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 17 14">
+                            <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M1 1h15M1 7h15M1 13h15"/>
+                        </svg>
+                    </button>
+                    <div class="hidden w-full md:block md:w-auto" id="navbar-solid-bg">
+                        <ul class="flex flex-col font-medium mt-4 rounded-lg bg-gray-50 md:space-x-8 rtl:space-x-reverse md:flex-row md:mt-0 md:border-0 md:bg-transparent dark:bg-gray-800 md:dark:bg-transparent dark:border-gray-700">
+                            <li>
+                                <a href="/landing" class="block py-2 px-3 md:p-0 text-gray-900 rounded hover:bg-gray-100 md:hover:bg-transparent md:border-0 md:hover:text-blue-700 dark:text-white md:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white md:dark:hover:bg-transparent">Home</a>
+                            </li>
+                            <li>
+                                <a href="/aboutUs" class="block py-2 px-3 md:p-0 text-white bg-blue-700 rounded md:bg-transparent md:text-blue-700 md:dark:text-blue-500 dark:bg-blue-600 md:dark:bg-transparent" aria-current="page">About Us</a>
+                            </li>
+                            <li>
+                                <a href="mailto:rcalculator@gmail.com" class="block py-2 px-3 md:p-0 text-gray-900 rounded hover:bg-gray-100 md:hover:bg-transparent md:border-0 md:hover:text-blue-700 dark:text-white md:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white md:dark:hover:bg-transparent">Contact us</a>
+                            </li>
+                        </ul>
+                    </div>
+                </div>
+            </nav>
+        </header>
+        <main>
+
+            <section class="bg-white dark:bg-gray-900 py-12 md:py-20">
+                <div class="max-w-screen-lg mx-auto px-4 text-center">
+                    <h1 class="mb-4 text-4xl font-extrabold tracking-tight leading-none text-gray-900 md:text-5xl lg:text-6xl dark:text-white">About RCalculator</h1>
+                    <p class="mb-12 text-lg font-normal text-gray-500 lg:text-xl sm:px-16 dark:text-gray-400">Welcome to RCalculator, your partner in building a secure and fulfilling financial future.</p>
+                </div>
+
+                <div class="max-w-screen-md mx-auto px-4">
+                    <h2 class="mb-4 text-3xl font-bold tracking-tight text-gray-900 dark:text-white text-center">Our Mission</h2>
+                    <p class="mb-6 font-normal text-gray-600 dark:text-gray-400 text-lg text-center">
+                        Our mission is to empower you with the tools and insights needed to take control of your long-term financial goals.
+                    </p>
+                    <div class="prose lg:prose-lg dark:prose-invert mx-auto text-gray-600 dark:text-gray-400">
+                        <p class="mb-4">
+                            We believe that planning for your desired future, especially retirement, shouldn't be daunting. It doesn't matter what your current age or career status is – starting now is what counts.
+                        </p>
+                        <p class="mb-4">
+                            At RCalculator, we help you trace a personalized plan that suits your unique aspirations. We provide clear, actionable advice and projections to guide you on how to get there, whether you're just starting your career, mid-way through, or nearing retirement.
+                        </p>
+                        <p>
+                            Let us help you navigate the path to financial independence and achieve the retirement lifestyle you envision.
+                        </p>
+                    </div>
+                </div>
+                <div class="flex flex-col space-y-4 sm:flex-row sm:justify-center sm:space-y-0">
+                    <a href="/login" class="inline-flex justify-center items-center mt-4 py-3 px-5 text-base font-medium text-center text-white rounded-lg bg-blue-700 hover:bg-blue-800 focus:ring-4 focus:ring-blue-300 dark:focus:ring-blue-900">
+                        Get started
+                        <svg class="w-3.5 h-3.5 ms-2 rtl:rotate-180" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 14 10">
+                            <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M1 5h12m0 0L9 1m4 4L9 9"/>
+                        </svg>
+                    </a>
+                </div>
+            </section>
+        </main>
+        <footer class="bg-gray-100 dark:bg-gray-800 border-t border-gray-200 dark:border-gray-700 p-6 text-center text-gray-500 dark:text-gray-400 text-sm">
+            <div class="container mx-auto">
+               <p>&copy; 2025 RCalculator. All rights reserved.</p>
+            </div>
+        </footer>
+        <script src="https://cdn.jsdelivr.net/npm/@tailwindcss/browser@4"></script>
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/flowbite/2.3.0/flowbite.min.js"></script>
+    </body>
+</html>
@@ -0,0 +1,64 @@
+<html>
+    <head>
+        <title>RCalculator</title>
+        <link rel="icon" href="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/rekor.png">
+        <link href="https://cdn.jsdelivr.net/npm/tailwindcss@3.3.2/dist/tailwind.min.css" rel="stylesheet">
+    </head>
+    <body class="bg-white dark:bg-gray-900">
+        <header>
+            <nav class="bg-gray-50 dark:bg-gray-800 border-b border-gray-200 dark:border-gray-700">
+                <div class="max-w-screen-xl flex flex-wrap items-center justify-between mx-auto p-4">
+                    <a href="#" class="flex items-center space-x-3 rtl:space-x-reverse">
+                        <img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/rekor.png" class="h-8" alt="Flowbite Logo" />
+                        <span class="self-center text-2xl font-semibold whitespace-nowrap dark:text-white">RCalculator</span>
+                    </a>
+                    <button data-collapse-toggle="navbar-solid-bg" type="button" class="inline-flex items-center p-2 w-10 h-10 justify-center text-sm text-gray-500 rounded-lg md:hidden hover:bg-gray-100 focus:outline-none focus:ring-2 focus:ring-gray-200 dark:text-gray-400 dark:hover:bg-gray-700 dark:focus:ring-gray-600" aria-controls="navbar-solid-bg" aria-expanded="false">
+                        <span class="sr-only">Open main menu</span>
+                        <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 17 14">
+                            <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M1 1h15M1 7h15M1 13h15"/>
+                        </svg>
+                    </button>
+                    <div class="hidden w-full md:block md:w-auto" id="navbar-solid-bg">
+                        <ul class="flex flex-col font-medium mt-4 rounded-lg bg-gray-50 md:space-x-8 rtl:space-x-reverse md:flex-row md:mt-0 md:border-0 md:bg-transparent dark:bg-gray-800 md:dark:bg-transparent dark:border-gray-700">
+                            <li>
+                                <a href="/landing" class="block py-2 px-3 md:p-0 text-white bg-blue-700 rounded md:bg-transparent md:text-blue-700 md:dark:text-blue-500 dark:bg-blue-600 md:dark:bg-transparent" aria-current="page">Home</a>
+                            </li>
+                            <li>
+                                <a href="/aboutUs" class="block py-2 px-3 md:p-0 text-gray-900 rounded hover:bg-gray-100 md:hover:bg-transparent md:border-0 md:hover:text-blue-700 dark:text-white md:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white md:dark:hover:bg-transparent">About Us</a>
+                            </li>
+                            <li>
+                                <a href="mailto:rcalculator@gmail.com" class="block py-2 px-3 md:p-0 text-gray-900 rounded hover:bg-gray-100 md:hover:bg-transparent md:border-0 md:hover:text-blue-700 dark:text-white md:dark:hover:text-blue-500 dark:hover:bg-gray-700 dark:hover:text-white md:dark:hover:bg-transparent">Contact us</a>
+                            </li>
+                        </ul>
+                    </div>
+                </div>
+            </nav>
+        </header>
+        <main>
+            <section class="bg-center bg-no-repeat bg-cover bg-[url('/images/bg1.jpg')] bg-gray-400 bg-blend-multiply">
+                <div class="px-4 mx-auto max-w-screen-xl text-center py-24 lg:py-56">
+                    <h1 class="mb-4 text-4xl font-extrabold tracking-tight leading-none text-white md:text-5xl lg:text-6xl">Plan now, live better.</h1>
+                    <p class="mb-8 text-lg font-normal text-gray-300 lg:text-xl sm:px-16 lg:px-48">Planning your retirement is a crucial step towards financial security and a happy future.</p>
+                    <div class="flex flex-col space-y-4 sm:flex-row sm:justify-center sm:space-y-0">
+                        <a href="/login" class="inline-flex justify-center items-center py-3 px-5 text-base font-medium text-center text-white rounded-lg bg-blue-700 hover:bg-blue-800 focus:ring-4 focus:ring-blue-300 dark:focus:ring-blue-900">
+                            Get started
+                            <svg class="w-3.5 h-3.5 ms-2 rtl:rotate-180" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 14 10">
+                                <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M1 5h12m0 0L9 1m4 4L9 9"/>
+                            </svg>
+                        </a>
+                        <a href="/aboutUs" class="inline-flex justify-center hover:text-gray-900 items-center py-3 px-5 sm:ms-4 text-base font-medium text-center text-white rounded-lg border border-white hover:bg-gray-100 focus:ring-4 focus:ring-gray-400">
+                            Learn more
+                        </a>  
+                    </div>
+                </div>
+            </section>
+        </main>
+        <footer class="bg-gray-100 dark:bg-gray-800 border-t border-gray-200 dark:border-gray-700 p-6 text-center text-gray-500 dark:text-gray-400 text-sm">
+            <div class="container mx-auto">
+               <p>&copy; 2025 RCalculator. All rights reserved.</p>
+            </div>
+        </footer>
+        <script src="https://cdn.jsdelivr.net/npm/@tailwindcss/browser@4"></script>
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/flowbite/2.3.0/flowbite.min.js"></script>
+    </body>
+</html>
Author	SHA1	Message	Date
nicoagostini	2a070d95c1	fix/README file folder structure updated	2025-05-02 01:52:05 -07:00
nicoagostini	eaecb883e6	update/landing page and aboutUs page created	2025-05-02 01:39:33 -07:00
nicoagostini	2bd4b1e16e	README updated with instructions	2025-05-01 19:31:07 -07:00
nicoagostini	7f9e594e9b	app.js file moved (fixing previous commit)	2025-05-01 19:25:57 -07:00
nicoagostini	1f9416e0bd	.env file created and app.js moved to root folder	2025-05-01 19:24:18 -07:00
Joaquin	e4a6c7ef36	merge feature/routing with dev	2025-04-30 17:17:00 -07:00
SowinskiBraeden	c1f3aa126b	Merge branch 'dev' of github.com:JoaquinPar/2800-202510-BBY14 into dev	2025-04-29 16:02:10 -07:00
SowinskiBraeden	f3ee6d091e	update/create about.html page	2025-04-29 16:00:59 -07:00
mitchell	a143dc439b	adding readme info	2025-04-29 15:57:56 -07:00