Skip to content

Commit b00ff28

Browse files
committed
deployed
0 parents  commit b00ff28

7 files changed

Lines changed: 215 additions & 0 deletions

Build and Deploy.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Run the following
2+
```bash
3+
npm run build
4+
5+
cd dist
6+
git init
7+
git add .
8+
git commit -m "deployed"
9+
git branch -M main
10+
git remote add origin https://github.com/Cyclone-Robosub/Cyclone-RoboSub.github.io.git
11+
git push -f origin main
12+
13+
```
14+
In case you already did not commit
15+
```bash
16+
git add .
17+
git commit -m "deployed"
18+
git push origin main
19+
```

Design Criteria.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
### [2.2.1 Deliverable Requirements](https://robonation.gitbook.io/robosub-resources/section-2-design-documentation/2.2-team-website#id-2.2.1-deliverable-requirements)
2+
1. Website Content: Layout and detailed contents of the website are left for the teams to develop; however, the team website must include:
3+
- Current team name and contact information
4+
- Vehicle photos and/or videos
5+
- Supporting media, which may include:
6+
- Instructional/Informative videos
7+
- Procedures (text, images)
8+
- Design decision documentation (text, images, videos)
9+
- Blogs for historical records of build progress
10+
- List of sponsors with logos
11+
12+
2. Website Quality: Websites are often the first impression of a project. Potential supporters such as supervisors, sponsors, or advisors must find the website visually appealing and easy to navigate. Development of the website should include careful consideration of user experience, including.
13+
- Written in English, or English translation provided
14+
- Clear prioritization of key content
15+
- Site search functionality
16+
- Basic design elements: contrast, repetition, alignment and grouping to organize/highlight content
17+
- User accessibility, as defined by the [W3C Web Accessibility Initiative: www.w3.org/WAI](https://www.w3.org/WAI/)
18+
- Cross browser compatibility for modern web browsers (Chrome, Firefox, Safari, MS Edge)
19+
- A mobile friendly display
20+
### [2.2.2 Scoring Metrics](https://robonation.gitbook.io/robosub-resources/section-2-design-documentation/2.2-team-website#id-2.2.2-scoring-metrics)
21+
#### Team Information (20% of score)
22+
Team website includes all required team information, including the team’s name and contact information, and a list of team members and sponsors. All mentions of the vehicle are relevant to the current competition year.
23+
#### Vehicle Design Documentation (40% of score)
24+
Vehicle development and testing process is thoroughly documented with instructional and informative supporting media and historical recording. This could include photographs, diagrams, videos, procedures (text + images), design documentation (text + images + video), or blogs for historical records.
25+
#### Website Quality (40% of score)
26+
Website places a heavy emphasis on human factors. Layout is visually appealing, easily maneuverable, and does an excellent job of drawing user’s attention to relevant content.
27+
## Other Resources
28+
- [2025 Team Time 1](https://robonation.org/app/uploads/sites/4/2025/02/RS25_TeamTime-Slides_2025-01-compressed-1.pdf#page=10)
29+
- [2024 Handbook](https://robonation.org/app/uploads/sites/4/2024/07/2024-RoboSub_Team-Handbook_v2.pdf#page=7)

Planned Structure.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
- Home Page
2+
- Title Page (spinny logo)
3+
- Org Info
4+
- How to Join
5+
- Contact Us
6+
- Projects
7+
- Image Gallery
8+
- Current Year Overview
9+
- Description
10+
- Year
11+
- Highlights PDFs
12+
- TDR
13+
- Previous Years
14+
- Team (relevant sections should be linked to each other)
15+
- Image Gallery
16+
- Current Year
17+
- Members
18+
- Alumni
19+
- Newsletters
20+
- Structure
21+
- Previous Years

Project Setup and Access.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Before you begin, make sure that you have installed the latest version of [Node.js](https://nodejs.org/en)
2+
3+
Once the install is complete, head to the repo directory and run the following.
4+
```bash
5+
npm install
6+
```
7+
> [!NOTE]
8+
> There will likely be multiple vulnerabilities, so run the following to fix the ones that it can. You **do not** need 0 vulnerabilities to proceed.
9+
> ```bash
10+
> npm audit fix
11+
> ```
12+
13+
Check that most recent version of `vue` (5.0.0 or sooner) is installed by running
14+
```bash
15+
npm list @vue/cli-service
16+
```
17+
If the `cli-service` is out of date, run
18+
```bash
19+
npm install @vue/cli-service@latest
20+
```
21+
22+
> [!WARNING]
23+
> If you start getting errors like `defineConfig is not a function` or `TypeError: transpileDependencies.map is not a function`, discard you repo changes and start over.
24+
25+
### Compiles and hot-reloads for development
26+
```
27+
npm run serve
28+
```
29+
30+
### Compiles and minifies for production
31+
```
32+
npm run build
33+
```
34+
35+
### Lints and fixes files
36+
```
37+
npm run lint
38+
```
39+
40+
### Customize configuration
41+
See [Configuration Reference](https://cli.vuejs.org/config/).

Resources.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## PDF Embed
2+
- [`vue-pdf-embed`](https://www.npmjs.com/package/vue-pdf-embed#examples)
3+
- ditched in favor of using google embed
4+
## Versioning
5+
https://semver.org/

Task List.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
Reference the [Design Criteria](Design%20Criteria.md)
2+
## Urgent
3+
- [x] Consolidate About Us and Mission Statement
4+
- [x] Update google search description text
5+
- [x] Update members for spring quarter
6+
- [x] Add a brief description of the robot next to image
7+
- [x] embed `breakdown.pdf`
8+
- [x] Update robot image
9+
- [x] join the team does not display correctly on mobile
10+
- [x] add how to join
11+
- [x] clean up join message
12+
- [x] add missing sponsor
13+
- [x] include embed for google calendar
14+
- [x] add more images of robot
15+
- [x] Find way to setup galleries
16+
- [x] Add team image gallery
17+
- [x] Add robot image gallery
18+
- [x] Team tab jumps to wrong place
19+
- [x] Nortek logo is broken
20+
- [x] discord link in team section is broken
21+
- [x] add sponsorship handbook
22+
## Not Urgent
23+
- [x] `Our Robot` has heading space issues
24+
- [x] hide pdf viewer scroll bar
25+
- [ ] should fit 3 images across on mobile
26+
- [ ] should fit 2 sponors across on mobile
27+
- [ ] carosel doesn't fit perfectly
28+
- [ ] Fix align on member list
29+
- [ ] make calendar size more dynamic
30+
- [x] make `Founding` section have more dynamic width
31+
- [x] make `How to Join` section have more dynamic width
32+
- [x] fix rounded corners of pdf background
33+
- [ ] add YouTube channel to contact list
34+
- [ ] choose consistent icon styling for contact section
35+
## Not Important
36+
- [ ] wave glitches out over time
37+
- [ ] scrolling on page startup reveals weirdness
38+
- [ ] create looping carousel for images and content
39+
- [ ] set up JSON for robot images
40+
- [ ] make logos SVG-accepting
41+
- [ ] make join message apart of `general.json`
42+
- [ ] Create Year setup
43+
- [ ] Add newsletters
44+
- [ ] Move members
45+
- [ ] Add alumni
46+
- [ ] Add image of team
47+
- [ ] Create a join page on the website that automatically switching in and out based on the time of year
48+
- [ ] create element for discord hyperlink
49+
- [ ] link to email doesn’t work?
50+
- [ ] Have embed 3D model of robot
51+
- [ ] Bonus points if you can make a cool CSS timeline
52+
- [ ] fix weird anti-aliasing on leadership images
53+
- [ ] apply null link logic to leadership
54+
- [ ] change CSV to JSON for lists

Team Descriptions.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# AI Revision
2+
## Who Are We?
3+
Cyclone RoboSub is an underwater robotics competition team at the University of California, Davis. Our team provides UC Davis students with opportunities for hands-on robotics engineering experience through the design and construction of an autonomous underwater vehicle (AUV) for the international RoboSub Competition. Our goal is to strengthen the UC Davis engineering community by developing talented, confident engineers who will make a positive impact on the world.
4+
## Founding
5+
Before the team was founded, there were few opportunities for students with a passion for robotics engineering to learn and apply their skills at UC Davis. We set out to change that.
6+
7+
Within a year, we helped students expand and develop their technical abilities and built a community of people enthusiastic about robotics. We operate on the principle that anyone motivated to learn is welcome to the team, regardless of experience. We provide opportunities for experienced members to lead, while also enabling new members to learn.
8+
## RoboSub
9+
RoboSub is an international student competition organized by RoboNation. Student teams from around the world design and build autonomous underwater vehicles (AUVs) to compete in various challenges.
10+
11+
The 2025 competition will be held this August at the Woollett Aquatics Center in Irvine, CA. Participating AUVs will complete tasks such as manipulating objects, maneuvering, and firing torpedoes, all while operating autonomously. The competition is intense, and top universities from around the world participate. We look forward to attending this summer!
12+
___
13+
# Human Revision
14+
## Who Are We?
15+
Cyclone RoboSub is a underwater robotics competition team at the University of California, Davis aimed at providing UC Davis students with opportunities to get hands-on robotics engineering experience as they design and build an autonomous underwater vehicle (AUV) for the international RoboSub Competition. Our goal is to strengthen UC Davis’ engineering community by building up talented, confident engineers who can go on to make a positive impact on the world.
16+
## Founding
17+
Before the team's founding, there were few opportunities for students with a passion for robotics engineering to learn and apply their skills at UC Davis. We set out to change that.
18+
19+
In the span of a year, we helped students expand and develop their technical abilities, and also built a community of people enthusiastic about robotics. We operate on the premise that anyone motivated to learn is welcome to the team regardless of experience, providing opportunities to experienced members to lead while also allowing new members to learn!
20+
## RoboSub
21+
RoboSub is an international student competition organized by RoboNation. Student teams from around the world design and build robotic submarines, otherwise known as Autonomous Underwater Vehicles (AUV), to compete in various challenges.
22+
23+
The 2025 competition will be held this August at the Woollett Aquatics Center in Irvine, CA. Robots are expected to complete tasks such as manipulating objects, maneuvering, and firing torpedoes, all while being completely autonomous. The competition is intense! Top universities from all over the world compete, and we can't wait to attend this summer!
24+
25+
___
26+
# Examples
27+
## From the Newsletter
28+
Cyclone RoboSub is a new underwater robotics competition team which provides UC Davis students with opportunities to get hands-on robotics engineering experience as they design and build an autonomous underwater vehicle (AUV) for the international RoboSub Competition. Our goal is to strengthen UC Davis’ engineering community by building up talented, confident engineers who can go on to make a positive impact on the world.
29+
## From the Sponsorship Packet
30+
### Intro
31+
Cyclone RoboSub is a robotics team based at the University of California, Davis providing students with opportunities to learn and enhance their engineering skills by developing autonomous underwater vehicles for the RoboSub competition. Our team is based on principles of community; this not only involves our students, but also our sponsors. This packet serves as a guide to our team and details the opportunities associated with supporting us!
32+
### Founding
33+
Before the team's founding, there were few opportunities for students with a passion for robotics engineering to learn and apply their skills at UC Davis. We set out to change that.
34+
35+
In the span of a year, we helped students expand and develop their technical abilities, and also built a community of people enthusiastic about robotics. We operate on the premise that anyone motivated to learn is welcome to the team regardless of experience. This model allows experienced members to lead while also allowing new members to learn!
36+
### RoboSub
37+
RoboSub is an international student competition organized by RoboNation. Student teams from around the world design and build robotic submarines, otherwise known as Autonomous Underwater Vehicles (AUV), to compete in various challenges.
38+
39+
The 2025 competition will be held this August at the Woollett Aquatics Center in Irvine, CA. Robots are expected to complete tasks such as manipulating objects, maneuvering, and firing torpedoes, all while being completely autonomous. The competition is intense! Top universities from all over the world compete.
40+
## Discord
41+
We are an underwater robotics team competing in the international RoboSub Competition. Registration opens at the start of every quarter. Please reach out to leadership for questions!
42+
## From the current (2025/05/02) website
43+
### Who are We?
44+
Before founding Cyclone RoboSub, there were few opportunities for students with a passion for robotic engineering to learn and apply their skills at UC Davis. We intend to change that. Not only do we plan to help students expand and develop their technical abilities, but we also want to build a community of people enthusiastic about robotics. We operate on the premise that anyone with the motivation to learn is welcome to the team, regardless of experience. We hope this model provides experienced members with the opportunity to lead while also giving new members the opportunity to learn! Cyclone RoboSub was founded alongside the opening of the brand new Engineering Student Design Center (ESDC). A major focus of the new center is to provide student design teams with access to state of the art machines and facilities. By working within the design center, our members gain invaluable experience in design and manufacturing which prepares them for industry.
45+
### Our Mission
46+
Cyclone RoboSub is dedicated to providing engineering and non-engineering students alike with opportunities to learn and enhance their skills by developing autonomous underwater vehicles for the RoboSub competition. Our team is based on principles of community, where we hope to foster new relationships between members and create an accepting environment for all people.

0 commit comments

Comments
 (0)