EduCompanio

May 3, 2024 ยท View on GitHub

Description

EduCompanio is a comprehensive platform designed to help college students navigate their academic and professional journeys. Motivated by personal experiences and the challenges faced by our peers, we built EduCompanio to provide a one-stop solution for students to organize, plan, and build their careers effectively. The platform offers features such as note organization, job and project tracking, access to resources, and AI-powered interview and pitch preparation tools.

Table of Contents

Installation

To set up the EduCompanio development environment, follow these steps:

  1. Clone the repository: git clone https://github.com/SirArnoldB/EduCompanio.git
  2. Navigate to the project directory: cd EduCompanio
  3. Install the dependencies for the backend:
    • Navigate to the backend directory: cd backend
    • Run npm install
  4. Install the dependencies for the frontend:
    • Navigate to the frontend directory: cd ../frontend
    • Run npm install

Usage

To start the EduCompanio application:

  1. Start the backend server:
    • Navigate to the backend directory: cd backend
    • Run npm start
  2. Start the frontend development server:
    • Navigate to the frontend directory: cd ../frontend
    • Run npm start
  3. Open your browser and visit http://localhost:3000 to access EduCompanio.

Credits

EduCompanio was developed by a dedicated team of contributors:

License

This project is licensed under the MIT License.

Contributing

This project is open-source and we welcome contributions from the community. Feel free to submit issues, feature requests, and pull requests to help us improve EduCompanio.