Skip to content

Latest commit

 

History

History
169 lines (103 loc) · 5.17 KB

README.md

File metadata and controls

169 lines (103 loc) · 5.17 KB
Raw

Skill Set Sail

Skill Set Sail is a comprehensive MERN stack application designed to facilitate job seeking and recruitment processes with an intuitive and user-friendly interface.

Features

For Employers:

  • Job Management:
    • Post Jobs: Create new job listings with details like job title, description, and requirements.
    • Edit Jobs: Modify existing job postings to update information or requirements.
    • Delete Jobs: Remove job listings that are no longer available or relevant.
    • View Applications: Access and review applications submitted by job seekers for each job listing.

For Job Seekers:

  • Job Search and Application:
    • Browse Jobs: Explore available job listings categorized by industry, location, or type.
    • Apply for Jobs: Submit applications with resumes and additional details required by employers.

Technologies Used

Frontend Dependencies

  • axios: Promise-based HTTP client for making requests to the backend API.
  • react: JavaScript library for building user interfaces using components.
  • react-dom: Provides DOM-specific methods for React.
  • react-hot-toast: Lightweight and customizable toast notifications for React applications.
  • react-icons: A collection of icons for React applications.
  • react-router-dom: DOM bindings for React Router for declarative routing in React applications.
  • react-spinners: Collection of loading spinners and indicators for React applications.

Backend Dependencies

  • bcrypt: Library to hash passwords securely before storing them.
  • cloudinary: Cloud-based image and video management service for handling file uploads.
  • cookie-parser: Middleware for parsing cookies attached to the client request object.
  • cors: Middleware for enabling CORS (Cross-Origin Resource Sharing) in the backend.
  • dotenv: Loads environment variables from a .env file into process.env.
  • express: Fast, unopinionated, minimalist web framework for Node.js.
  • express-fileupload: Simple middleware for handling file uploads.
  • jsonwebtoken: JSON Web Token implementation to generate and verify tokens.
  • mongoose: MongoDB object modeling tool designed to work in an asynchronous environment.
  • validator: A library of string validators and sanitizers.

Getting Started

  1. Clone the repository:

    git clone https://github.com/hallowshaw/SkillSetSail.git
cd SkillSetSail

  2. Install frontend dependencie:

    cd Frontend
npm install

  3. Install backend dependencie:

    cd Backend
npm install

  4. Set up environment variables:

    • Create a .env file in the Backend directory config folder with the following variables
    PORT = 4000
CLOUDINARY_CLIENT_NAME=
CLOUDINARY_CLIENT_API=
CLOUDINARY_CLIENT_SECRET=
FRONTEND_URL=http://localhost:5173
MONGO_URI= 
JWT_SECRET_KEY=eyJhbGciOiJIUzI1NiJ9
JWT_EXPIRES=7d
COOKIE_EXPIRE=5

  5. Start the frontend and backend servers:

    # In the Frontend directory
npm run dev

# In the Backend directory
npm run dev

Contributing

Contributions are welcome! Please follow these steps to contribute to Skill Set Sail:

  1. Fork the repository and clone it locally:

    git clone https://github.com/hallowshaw/Skill-Set-Sail.git
cd Skill-Set-Sail

  2. Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name

  3. Make your changes and commit them:

    git add .
git commit -m "Add your detailed description of changes"

  4. Push to your branch:

    git push origin feature/your-feature-name

  5. Submit a pull request detailing the changes you made and why they are valuable.

  6. Your pull request will be reviewed. Once approved, it will be merged into the main branch.

Development Guidelines

When contributing to Skill Set Sail, please follow these guidelines:

  • Code Style: Follow the existing code style and structure of the project.

  • Commit Messages: Write clear and concise commit messages that explain the purpose of your changes.

  • Documentation: Update documentation as needed to reflect your changes.

  • Pull Requests: Submit a pull request detailing the changes made and provide a brief description of why they are valuable. Include any relevant information that may assist reviewers.

  • Review: Be responsive to feedback and be prepared to make further changes as requested during the review process.

  • Linting: Ensure your code adheres to linting rules and does not introduce any new linting errors or warnings.


By following these guidelines, you contribute to maintaining a high standard of quality and consistency in the Skill Set Sail project.

Thank you for setting sail with Skill Set Sail! Your contributions are like wind in our sails, propelling us forward and steering us toward excellence. Together, we chart a course to build something remarkable that benefits everyone involved. Let's navigate this journey together and make waves in the world of job seeking and recruitment. Fair winds and following seas!