FBLA25/README.md
drake 705c3d63aa
All checks were successful
ci / docker_image (push) Successful in 1m38s
ci / deploy (push) Successful in 16s
README.md
2025-03-29 17:43:50 -05:00

84 lines
1.9 KiB
Markdown

# 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)