Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/docker-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ jobs:
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8

# Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
- name: Log in to the Container registry
uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
Expand All @@ -35,7 +35,7 @@ jobs:
# This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
Expand All @@ -47,7 +47,7 @@ jobs:
# It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
- name: Build and push Docker image
id: push
uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83
with:
context: .
push: true
Expand All @@ -56,7 +56,7 @@ jobs:

# This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)."
- name: Generate artifact attestation
uses: actions/attest-build-provenance@db473fddc028af60658334401dc6fa3ffd8669fd
uses: actions/attest-build-provenance@977bb373ede98d70efdf65b84cb5f73e068dcc2a
with:
subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
subject-digest: ${{ steps.push.outputs.digest }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docker-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8

- name: "Build Docker Image"
run: |
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/eslint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@ jobs:
eslint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
- uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
- uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903
with:
node-version: 22

- name: Install dependencies
run: npm ci

- name: Run EsLint
uses: sibiraj-s/action-eslint@bcf41bb9abce43cdbad51ab9b3da2eddaa17eab3
uses: sibiraj-s/action-eslint@c24ff92cabb3ad38994c99f5583c59125ea040b0
with:
eslint-args: "src/**/*.{ts,tsx} --max-warnings=0"
extensions: "ts,tsx"
Expand Down
Binary file removed LabConnect S25 Documentation.pdf
Binary file not shown.
125 changes: 38 additions & 87 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,12 @@
[![Stargazers][stars-shield]][stars-url]


<!-- TABLE OF CONTENTS -->
<details>
<summary> Table of Contents </summary>
<ol>
<li>
<a href="#about"> About the project</a>
<ul>
<li><a href="#built-with">Built With</a>
</ul>
</li>
<li>
<a href="#prerequisites"> Prerequisites</a>
</li>
<li>
<a href="#installation"> Installation</a>
</li>
</ol>
</details>


<!-- ABOUT THE PROJECT -->
## About
<div align="center">
<a href="https://github.com/LabConnect-RCOS/LabConnect-Backend">
<!-- <img src="https://github.com/RafaelCenzano/LabConnect/blob/main/bargeLogo.png" alt="Barge Logo" width="360" height="216"> -->
</a>
<img src="src/images/LabConnect_Logo-removebg-preview.png" alt="LabConnect Logo" width="360">
<img src="src/images/LabConnect_Logo-removebg-preview.png" alt="LabConnect Logo" width="360">
</a>
<br/><br/>

<p align="center">A centralized website to connect RPI undergraduate students with research or lab positions<br>
Expand All @@ -44,12 +23,7 @@ posted by professors, graduate students, or lab staff.</p>

### Built With

[![Python][Python]][Python-url]
[![HTML][HTML]][HTML-url]
[![CSS][CSS]][CSS-url]
[![JS][JS]][JS-url]
[![Flask][Flask]][Flask-url]
[![Bootstrap][Bootstrap]][Bootstrap-url]
[![TypeScript][TypeScript]][TypeScript-url]
[![React][React]][React-url]
[![Node.js][Node.js]][Node.js-url]
[![Tailwind CSS][TailwindCSS]][TailwindCSS-url]
Expand All @@ -63,13 +37,12 @@ posted by professors, graduate students, or lab staff.</p>
$ git clone https://github.com/LabConnect-RCOS/LabConnect-Frontend.git
```
* or through [Github Desktop](https://desktop.github.com/)
* Install Python 3.12.4
* Windows: [here](https://www.python.org/downloads/release/python-3124/)
* Linux:
* Install Node and NPM. Recommend using nvm to manage node versions. The frontend currently uses `Node 22`
* Mac:
```
$ sudo apt install python3
$ brew install nvm
$ nvm install node
```
* Install Node and NPM
* Windows: [here](https://nodejs.org/dist/v22.20.0/node-v22.20.0-x64.msi)
* Linux:
```
Expand All @@ -85,59 +58,47 @@ posted by professors, graduate students, or lab staff.</p>
$ npm install
```

### Environment Variables

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

Set the varaible with:
```
$ export VITE_BACKEND_SERVER="http://127.0.0.1:9000"
```

## Testing
* To run the frontend locally run the following:
```
$ npm run build
$ npm run preview
$ make develop
```
This command allows editing and autoreloading while making changes

## 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.

## 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
## Building
* To build the application use this command to build the static files and test the production version of deploy the files.
```
npm run build
```

- **Mohammed P** [Backend] (S'25)
- **Sagar S** [Frontend] (S'25)
- **Gowrisankar P** [Frontend] (S'25)
- **Devan P** [Frontend] (S'25)
- **Sidarth E** [Frontend] (F'24,S'25)
- **Sarah W** [Backend] (S'24,F'24,S'25,U'25)
- **Ramzey Y** [Backend] (S'24,F'24)
- **Siddhi W** [Frontend / Backend] (F'23,S'24,F'24)
- **Mrunal A** [Frontend / Backend] (F'23,S'24,F'24)
- **Abid T** [Frontend / Backend] (F'23,S'24)
- **Nelson** [Backend] (S'24)
- **Duy L** [Database Systems] (F'23)
- **Yash K** [Frontend] (F'23)
- **Sam B** [Scraping / Integration] (F'23)
## 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

### Special Thanks
We extend our special thanks support and opportunity provided by the RCOS community.
Run the linter and fix any lint issues to maintiain code quality and standards
```
make lint
```

### Contact Us
Join our Discord for any questions or concerns [here](https://discord.gg/tsaxCKjYHT)
## Contact Us
[![Discord](https://img.shields.io/badge/Discord-5865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/tsaxCKjYHT)
[![Jira](https://img.shields.io/badge/Jira-0052CC.svg?style=for-the-badge&logo=jira&logoColor=white)](https://rcoslabconnect.atlassian.net/jira/software/projects/CCS/list)

## License

Distributed under the Apache License. See [LICENSE](https://github.com/RafaelCenzano/LabConnect/blob/main/LICENSE) for more information.
Distributed under the Apache License. See [LICENSE](https://github.com/LabConnect-RCOS/LabConnect-Frontend/blob/main/LICENSE) for more information.

<!-- https://home.aveek.io/GitHub-Profile-Badges/ -->

Expand All @@ -156,18 +117,8 @@ Distributed under the Apache License. See [LICENSE](https://github.com/RafaelCen
[activity-shield]: https://img.shields.io/github/last-commit/LabConnect-RCOS/LabConnect-Frontend?style=for-the-badge
[activity-url]: https://github.com/LabConnect-RCOS/LabConnect-Frontend/activity

[Python]: https://img.shields.io/badge/Python-3776AB.svg?style=for-the-badge&logo=Python&logoColor=white
[Python-url]: https://www.python.org/
[HTML]: https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white
[HTML-url]: https://html.spec.whatwg.org/multipage/
[CSS]: https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white
[CSS-url]: https://www.w3.org/Style/CSS/Overview.en.html
[JS]: https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black
[JS-url]: https://www.javascript.com/
[Flask]: https://img.shields.io/badge/Flask-000000?style=for-the-badge&logo=flask&logoColor=white
[Flask-url]: https://flask.palletsprojects.com/en/3.0.x/
[Bootstrap]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com/
[TypeScript]: https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white
[TypeScript-url]: https://www.typescriptlang.org/
[React]: https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=black
[React-url]: https://reactjs.org/
[Node.js]: https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white
Expand Down
Binary file removed labonnect_S25_poster.pdf
Binary file not shown.