From 2bd4b1e16e3e52891932dbc06e71d6ea7b9f8759 Mon Sep 17 00:00:00 2001 From: nicoagostini Date: Thu, 1 May 2025 19:31:07 -0700 Subject: [PATCH] README updated with instructions --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 766c1ce..71982c6 100755 --- a/README.md +++ b/README.md @@ -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,7 +53,6 @@ Example: ``` retirementCalculator/ ├── src/ -| ├── app.js │ ├── views/ │ ├── public/ | | ├── css/ @@ -45,6 +60,7 @@ retirementCalculator/ | | ├── images/ | | └── scripts/ │ └── util/ +├── app.js ├── .env.example ├── .gitignore ├── LICENSE