Skip to content

MahmoodAbuGneam/EduLink

Repository files navigation

EduLink

EduLink is an educational platform designed to connect students, instructors, and employers. It facilitates the sharing of educational materials, job postings, and workshop announcements.

Features

  • Solves a big problem for every student around the globe
  • User Authentication: Secure login and registration system for users.
  • Profile Management: Users can manage their profiles, including posting updates and managing personal information.
  • Job Posts: Employers can post job vacancies, and students or alumni can apply to these jobs.
  • Workshops: Instructors can create workshops, and students can register to participate.
  • Search Functionality: Robust search functionality to find users, job posts, and workshops.
  • Report Problems: Users can report problems directly through a modal in the navbar.
  • Work for students : Students can find jobs easily that fits their schedule of education.
  • Employers finding employee : Employers can find employees faster and easier and can help students by that .

Technologies Used

  • Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine.
  • Express: A minimal and flexible Node.js web application framework.
  • MongoDB: A NoSQL database used to store application data.
  • Mongoose: An ODM (Object Data Modeling) library for MongoDB and Node.js.
  • EJS: A templating language to generate HTML with plain JavaScript.
  • Bootstrap: A front-end framework for developing responsive and mobile-first websites.

Getting Started

Prerequisites

  • Node.js
  • MongoDB

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/edulink.git
    cd edulink
    
    npm install
    

    Change the mongoDB URL :

    DB_URI=mongodb+srv://yourMongoDBUriHere
    JWT_SECRET=yourSecretKey
    

    To Start the server :

    npm start
    

After starting the server, you can access the application by navigating to http://localhost:3000 in your web browser.

Running Tests To run tests, run the following command:

   npm test

Contributing Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project Create your Feature Branch (git checkout -b feature/AmazingFeature) Commit your Changes (git commit -m 'Add some AmazingFeature') Push to the Branch (git push origin feature/AmazingFeature) Open a Pull Request License Distributed under the MIT License. See LICENSE for more information.

Contact Mahmood Gneam - Mahmoab13@ac.sce.ac.il Mohammed Sholdoum - mohamma14@ac.sce.ac.il Islam Mhareeq - islammh@ac.sce.ac.il Yusef AlSayed - yoseyosey@ac.sce.ac.il

Acknowledgements

  • Node.js
  • Express
  • MongoDB
  • Mongoose
  • Bootstrap

This README includes an overview of the project, a list of features, the technologies used, installation instructions, how to get started with the project, testing instructions, how to contribute, licensing info, contact details, and acknowledgments. Adjust the links and specific project details to match your repository information and personal contact details.

About

A project for a course in SCE 2nd year, a student service application.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors