From 705c3d63aa4843a488fb69c4035c9408b6177b1f Mon Sep 17 00:00:00 2001
From: drake <dragonduckymarino@gmail.com>
Date: Sat, 29 Mar 2025 17:43:50 -0500
Subject: [PATCH] README.md

---
 .env.example | 12 ++++++++
 README.md    | 84 +++++++++++++++++++++++++++++++++++++++++++++++++---
 2 files changed, 92 insertions(+), 4 deletions(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..098be26
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,12 @@
+POSTGRES_HOST=192.168.0.200
+POSTGRES_PORT=5432
+POSTGRES_DB=fbla25
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgrespw
+JWT_SECRET=Secret
+EMAIL_HOST=marinodev.com
+EMAIL_PORT=465
+EMAIL_USER=careerconnectnotifier@marinodev.com
+EMAIL_PASS=userpassword
+BASE_URL=https://fbla25.marinodev.com
+
diff --git a/README.md b/README.md
index 57cd177..11415a5 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,83 @@
-## FBLA25
+# CareerConnect -  FBLA 2025
+
+## Overview
+
+This is a job board application built using [SvelteKit](https://kit.svelte.dev/) for the 2025 FBLA Website Coding & Development event. It allows users to browse job listings, post new job opportunities, and manage job applications. The application is designed for fast performance and a seamless user experience.
+
+## Features
+
+- User authentication (login/signup/logout)
+- Browse job listings
+- Post new job listings
+- Apply for jobs
+- Permissions system
+- Themes
+- Companies
+
+## Installation
+
+To set up the project locally, follow these steps:
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/) (LTS recommended)
+- [npm](https://www.npmjs.com/) or [pnpm](https://pnpm.io/)
+
+### Clone the repository
+
+```sh
+git clone https://git.marinodev.com/MarinoDev/FBLA25
+cd FBLA25
+```
+
+Create a `.env` file in the root directory and configure environment variables. `.env.example` is provided as a template.
+
+### Docker
+
+A `Dockerfile` and `docker-compose.yml` file are provided for running the application in a Docker container.
+
+### Manual
+
+#### Install dependencies
+
+```sh
+npm install
+```
+
+#### Start the development server
+
+```sh
+npm run dev
+```
+
+Go to `http://localhost:5173/` (or the port shown in the terminal).
+
+## Deployment
+
+To deploy the application, build it using:
+
+```sh
+npm run build
+node server.js
+```
+
+## Resources Used
+
+### Technologies
+
+- [SvelteKit](https://kit.svelte.dev/)
+- [Tailwind CSS](https://tailwindcss.com/)
+
+### Libraries
+
+- [dotenv](https://www.npmjs.com/package/dotenv)
+- [express](https://www.npmjs.com/package/express)
+- [bcrypt](https://www.npmjs.com/package/bcrypt)
+- [desm](https://www.npmjs.com/package/desm)
+- [nodemailer](https://www.npmjs.com/package/nodemailer)
+- [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken)
+- [postgres](https://www.npmjs.com/package/postgres)
+- [js-cookie](https://www.npmjs.com/package/js-cookie)
 
 
 
-## Future Features
-
-- [ ] Separation of companies and employers
\ No newline at end of file