Placement Connect is a web application that connects job seekers with potential employers. The frontend of the application is built using Vue.js, while the backend is powered by Flask. This README provides an overview of the project, installation instructions, and other important information for developers.
Tech Stack Used - Vuejs, Flask, Flask-Restful(API's), MongoDB, Python, Bootstrap(Responsiveness)
Before you begin, ensure you have met the following requirements:
- Node.js and npm installed for the Vue.js frontend.
- Python and pip installed for the Flask backend.
- MongoDB database (or another database of your choice) set up and configured.
- Git installed for version control.
To get the Placement Connect app up and running, follow these steps:
-
Clone the repository:
git clone https://github.com/yourusername/placement-connect.git
-
Navigate to the project directory:
cd placement-connect
-
Navigate to the frontend directory:
cd frontend
-
Install dependencies:
npm install
-
Start the development server:
npm run serve
-
Navigate to the backend directory:
cd backend
-
Create a virtual environment (optional but recommended):
python -m venv venv
-
Activate the virtual environment:
-
On Windows:
venv\Scripts\activate
-
On macOS and Linux:
source venv/bin/activate
-
-
Install Python dependencies:
pip install -r requirements.txt
-
Set up your database and configure the Flask application. You might need to create a
.env
file with your configuration variables (e.g., database URL, secret key). -
Run the Flask application:
python app.py
The project structure is as follows:
frontend/
: Vue.js frontend code.backend/
: Flask backend code.requirements.txt
: Python dependencies for the backend.