About

A centralized website to connect RPI undergraduate students with research or lab positions
posted by professors, graduate students, or lab staff.

Built With

Current Frontend UI

Prerequisites

• Clone
  • Clone repo through CLI

    $ git clone https://github.com/LabConnect-RCOS/LabConnect-Frontend.git

  • or through Github Desktop
• Install Node and NPM. Recommend using nvm to manage node versions. The frontend currently uses Node 22
  • Mac:

    $ brew install nvm
    $ nvm install node
    

  • Windows: here
  • Linux:

    $ sudo apt install curl
    $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
    

    Close and reopen terminal then run:

    $ nvm install node
    

• Install Packages

  $ npm install
  

Environment Variables

Variable Name	Default Value	Description
VITE_BACKEND_SERVER	None	URL to the backend server

• Set the variable with:

  $ export VITE_BACKEND_SERVER="http://127.0.0.1:9000"
  

Testing

• To run the frontend locally run the following:

  $ make develop
  

  This command allows editing and autoreloading while making changes

Linting

• Run the linter and fix any lint issues to maintiain code quality and standards

  make lint
  

Building

• To build the application use this command to build the static files and test the production version of the files.

  $ npm run build
  

  This command allows editing and autoreloading while making changes

Deployment

Create PRs to the main branch from your working branch. Make sure your new code is tested and bug free. Upon creating a merge request, a build test will make sure your code is running without errors and safe to merge to main.

Contact Us

Project Contributors

Running list of contributors to the LabConnect project:

Project Lead

• Will Broadwell [Project Lead]
• Rafael Cenzano [Former Project Lead]

Rensselaer Center for Open Source Development Team

• Jaswanth D [Frontend]
• Doan N [Frontend]
• Pragathi A [Frontend / Backend]
• Aniket S [Backend]

Past Rensselaer Center for Open Source Development Team

Deployment

Create PRs to the main branch. Upon merging, a build test will make sure your code is running without errors and safe to merge to main. On a completed merge the action will build and push the new docker image.

Linting

Run the linter and fix any lint issues to maintiain code quality and standards

make lint

Contact Us

License

Distributed under the Apache License. See LICENSE for more information.