Connect-U

Table of Contents

1. About The Project
   • Introduction
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact

About The Project

Introduction

Connect-U is a career service platform designed to connect students with potential employers. Using this web application, students can find suitable job opportunities and employers can find qualified candidates for their job openings.

Check out the deployment of the project here.

Features

Student

• Create and manage student profile
• Browse available job postings
• Apply to job postings
• View the status of their job application including email updates

Employers

• Create and manage employer profile
• Add and manage job postings
• Review candidate applications and resumes
• Notify candidate that they have been selected for an interview

Administrators

• Moderate system users
• Moderate job postings

Built With

• Python (Django)
• HTML
• CSS
• Bootstrap
• Font Awesome

(back to top)

Getting Started

Prerequisites

• Python 3.8 or higher installed on your system
• PyCharm (highly recommended for development). Download here.

Installation

1. Clone the repo

Clone the repository by running the following command in your terminal:

git clone https://github.com/emeka-okechukwu-dev/connect-u.git

2. Set up a Python virtual environment (Mac users)

Create a new Python virtual environment by running the following command:

python3 -m venv env

Activate the virtual environment by running:

source env/bin/activate

3. Install requirements, apply migrations, create superuser, and run server:

Navigate to the project directory and run the following command to install the required packages, apply the database migrations, create a superuser account, and start the development server:

pip install -r requirements.txt

python manage.py migrate

python manage.py createsuperuser

python manage.py runserver

4. Create a .env file in the project root directory with the following format:

SECRET_KEY = your_secret_key
EMAIL_HOST_USER = your_smtp_username
EMAIL_HOST_PASSWORD = your_smtp_password

5. Access the application

Open a web browser and navigate to the following URL:

http://localhost:8000/

You should now be able to access the application locally.

(back to top)

Contributing

Every contribution is appreciated. If you have an idea for improving the project, please fork the repository and create a pull request or open an issue with the tag "enhancement" to share your suggestion.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Emeka Okechukwu - [email protected]

(back to top)