This repository contains the source code for CodeCareerNepal, a job portal application. The application is built using Node.js, Express, MongoDB, and Puppeteer for web scraping.
- MongoDB Schemas
- API Routes
- Scraping Routes
- Utility Functions
- Docker Configuration
- Environment Configuration
- Application Setup
- Usage
jobName
: String, required.jobUrl
: String, required.updatedAt
: Date, default: current date.
companyName
: String, required.totalJobs
: Array ofjobSchema
, required.createdAt
: Date, default: current date.updatedAt
: Date, default: current date.
currentIndex
: Number, default: 0.updatedAt
: Date, default: current date.
- Returns a paginated list of all company job listings.
- Fetches and returns intern jobs using the
getInternJobs
utility function.
- Returns job listings for a specific company based on the provided company ID.
- Initiates web scraping for multiple companies using predefined scraping functions.
- Scraping functions are defined for companies such as Cotiviti, FuseMachine, LeapFrog, and others.
- Filters and projects relevant intern jobs from the MongoDB collection.
- Stores job data into the MongoDB collection.
The application is containerized using Docker.
- Base image: Puppeteer (version 21.6.1).
- Installs Node.js dependencies and sets the entry point to
index.js
.
- Environment variables are loaded using the
dotenv
package. - Key variables include
MONGODB_URI
for MongoDB connection andPORT
for the application.
- Clone the repository:
git clone https://github.com/anishjoshi1999/CodeCareerNepal.git
- Install dependencies:
npm install
- Set up environment variables: Create a
.env
file with required configurations. - Start the application:
npm start
ornpm run dev
for development.
- Access the job portal API through the defined routes.
- Initiate web scraping for new job listings using the
/scrape
route.
Note: Ensure proper error handling, logging, and security measures are implemented before deploying the application in a production environment.
Thank you for considering contributing to our project! We appreciate the community's involvement in making this project better.
There are several ways you can contribute to this project:
-
Reporting Bugs: If you find a bug, please open an issue. Provide a clear and detailed description, including steps to reproduce the issue.
-
Suggesting Enhancements: Have an idea to improve the project? Feel free to open an issue with your enhancement suggestion, and we can discuss it.
-
Fixing Issues: Want to tackle an existing issue or contribute a new feature? Fork the repository, create a new branch, make your changes, and submit a pull request.
To contribute to this project, follow these steps:
-
Fork the repository to your GitHub account.
-
Clone the forked repository to your local machine:
git clone https://github.com/anishjoshi1999/CodeCareerNepal-Server.git
-
Create a new branch for your contribution:
git checkout -b feature/your-feature
-
Make your changes and test them thoroughly.
-
Commit your changes:
git commit -m "Your meaningful commit message"
-
Push your changes to your fork:
git push origin feature/your-feature
-
Open a pull request on the original repository. Clearly describe your changes and reference any related issues.
Follow the established coding style and guidelines for this project. If there are specific conventions to adhere to, they will be mentioned here. Ensure that your code passes any existing tests.
Please adhere to our Code of Conduct. We aim to foster a welcoming and inclusive community.
By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.
Thank you for your contribution!