Skip to content

Commit

Permalink
feat: Add devsoc name and replace most csesoc references (#803)
Browse files Browse the repository at this point in the history
* feat: Add devsoc logo and replace most csesoc references

* update github source link

* updated code owners and devsoc github links

* updated links in onboarding and codeowners devsoc technical

---------

Co-authored-by: Shaam <[email protected]>
  • Loading branch information
3bobchen and Shzmj authored Jan 26, 2024
1 parent 1d10b89 commit fdb6514
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 40 deletions.
10 changes: 5 additions & 5 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
auto_server/ @csesoc/notangles-leads
client/ @csesoc/notangles-leads
server/ @csesoc/notangles-leads
auto_server/ @devsoc-unsw/notangles-leads
client/ @devsoc-unsw/notangles-leads
server/ @devsoc-unsw/notangles-leads

.github/ @csesoc/technical
renovate.json @csesoc/technical
.github/ @devsoc-unsw/platform
renovate.json @devsoc-unsw/platform
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Notangles

Copyright (C) 2023 CSESoc UNSW
Copyright (C) 2023 DevSoc UNSW

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Expand Down Expand Up @@ -37,7 +37,7 @@ party components included in the software.
6. If you use this software in a product that is freely available to the
public, you must give full credit to the original authors of the software by
prominently displaying the following attribution in the product: "This product
includes software developed by CSESoc UNSW."
includes software developed by DevSoc UNSW."

7. This license extension shall not be interpreted to affect the validity or
enforceability of the AGPL-v3 license.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Before you start, make sure that you have the following software installed.

Clone the repository:

`git clone [email protected]:csesoc/notangles.git`
`git clone [email protected]:devsoc-unsw/notangles.git`

### Running the front-end

Expand Down
4 changes: 2 additions & 2 deletions client/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
/>
<meta
name="description"
content="An interactive drag-and-drop timetable planner to help UNSW students plan and organise their course classes every trimester. Created by CSESoc Dev, we have many features including support for your own custom events, auto-timetabling, creation of multiple timetables and sharing events with friends. Organise your studies, find ideal class times with friends and take control of your academic life. Start planning now!"
content="An interactive drag-and-drop timetable planner to help UNSW students plan and organise their course classes every trimester. Created by DevSoc, we have many features including support for your own custom events, auto-timetabling, creation of multiple timetables and sharing events with friends. Organise your studies, find ideal class times with friends and take control of your academic life. Start planning now!"
/>
<meta
name="keywords"
content="notangles, crossangles, bojangles, UNSW, timetable, timetabler, planner, plan, calendar, trimester, trimesters, semester, term, social timetabling, schedule, csesoc, myUNSW, student, academic, organise, organize, courses, classes, auto-timetabler, University of New South Wales, tool, study, app, manage, personalise, customise"
content="notangles, crossangles, bojangles, UNSW, timetable, timetabler, planner, plan, calendar, trimester, trimesters, semester, term, social timetabling, schedule, csesoc, devsoc, myUNSW, student, academic, organise, organize, courses, classes, auto-timetabler, University of New South Wales, tool, study, app, manage, personalise, customise"
/>
<link rel="manifest" href="/manifest.json" />
<link rel="apple-touch-icon" href="/icon-192x192.png" />
Expand Down
6 changes: 3 additions & 3 deletions client/src/components/Footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ const Footer: React.FC = () => {
<div>
<h1 style={{ fontSize: '14px' }}>Notangles - UNSW Timetable Planner</h1>
<p>
Notangles is a UNSW timetable planner, brought to you by CSESoc Dev. It's an easy to use drag-and-drop tool
Notangles is a UNSW timetable planner, brought to you by DevSoc. It's an easy to use drag-and-drop tool
that allows you to plan your course classes and add to your calendar, even before term class registration
opens! We have many features including support for custom events, auto-timetabling, creation of multiple
timetables and sharing events with friends.
Expand All @@ -58,7 +58,7 @@ const Footer: React.FC = () => {
reliability.
</div>
<div>
Made by &gt;_ CSESoc UNSW&nbsp;&nbsp;•&nbsp;&nbsp;
Made by Software Development Society (DevSoc)&nbsp;&nbsp;•&nbsp;&nbsp;
<Link target="_blank" href="mailto:[email protected]">
Email
</Link>
Expand All @@ -67,7 +67,7 @@ const Footer: React.FC = () => {
Feedback
</Link>
&nbsp;&nbsp;•&nbsp;&nbsp;
<Link target="_blank" href="https://github.com/csesoc/notangles">
<Link target="_blank" href="https://github.com/devsoc-unsw/notangles">
Source
</Link>
</div>
Expand Down
47 changes: 27 additions & 20 deletions client/src/components/navbar/About.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,55 +26,62 @@ const FeatList = styled('ul')`
const About: React.FC = () => {
return (
<>
<Typography gutterBottom variant="body2">
<Typography gutterBottom variant='body2'>
Notangles is an app for UNSW students to build their perfect timetable, even before class registration opens. We
have many features on the way, including support for your own custom events, and syncing your timetable with
friends.
</Typography>
<Typography gutterBottom variant="body2">
<Typography gutterBottom variant='body2'>
Inspired by&nbsp;
<Link href="https://tdransfield.net/projects/bojangles/" target="_blank">
<Link href='https://tdransfield.net/projects/bojangles/' target='_blank'>
Bojangles
</Link>
&nbsp;and&nbsp;
<Link href="https://crossangles.app/" target="_blank">
<Link href='https://crossangles.app/' target='_blank'>
Crossangles
</Link>
, it was created by CSESoc Projects – a place for student-led projects where you can learn something new, and
make some friends along the way. Notangles is free and{' '}
<Link href="https://github.com/csesoc/notangles">open-source</Link>.
make some friends along the way.
</Typography>
<StyledTypography variant="h6">How it works</StyledTypography>
<Typography gutterBottom variant="body2">
<Typography gutterBottom variant='body2'>
In 2024, Software Development Society has assumed management for Notangles, formed by the creation of a new
student society from what was previously known as CSESoc Projects.
</Typography>
<Typography gutterBottom variant='body2'>
Notangles is free and{' '}
<Link href='https://github.com/devsoc-unsw/notangles'>open-source</Link>.
</Typography>
<StyledTypography variant='h6'>How it works</StyledTypography>
<Typography gutterBottom variant='body2'>
Select your courses, then drag-and-drop classes to customise your timetable. You can drag clutter (like lectures
which you aren’t going to watch live) to the unscheduled column. Struggling to find an ideal timetable? Try out
our auto-timetabling feature!
</Typography>
<HowToUseImg src={useGif} alt="how to use gif" />
<Typography gutterBottom variant="body2">
<HowToUseImg src={useGif} alt='how to use gif' />
<Typography gutterBottom variant='body2'>
Note: Notangles does not enroll in your classes. It’s a tool for planning your timetable, but you’ll still need
to officially enroll at&nbsp;
<Link href="https://my.unsw.edu.au/" target="_blank">
<Link href='https://my.unsw.edu.au/' target='_blank'>
myUNSW
</Link>
.
</Typography>
<StyledTypography variant="h6">Future developments</StyledTypography>
<StyledTypography variant='h6'>Future developments</StyledTypography>
<FeatList>
<li> Sync your timetable with friends</li>
</FeatList>
<StyledTypography variant="h6">About the team</StyledTypography>
<Typography gutterBottom variant="body2">
<StyledTypography variant='h6'>About the team</StyledTypography>
<Typography gutterBottom variant='body2'>
The current 2023 development team consists of two directors and seven members.
</Typography>
<Typography gutterBottom variant="body2">
<Typography gutterBottom variant='body2'>
<strong>Team Directors:</strong>
</Typography>
<FeatList>
<li>Manhua Lu</li>
<li>Raiyan Ahmed</li>
</FeatList>
<Typography gutterBottom variant="body2">
<Typography gutterBottom variant='body2'>
<strong>Members:</strong>
</Typography>
<FeatList>
Expand All @@ -86,14 +93,14 @@ const About: React.FC = () => {
<li>Sijin Soon</li>
<li>Wanning Cai</li>
</FeatList>
<StyledTypography variant="h6">Disclaimer</StyledTypography>
<Typography gutterBottom variant="body2">
<StyledTypography variant='h6'>Disclaimer</StyledTypography>
<Typography gutterBottom variant='body2'>
While we try our best, Notangles is not an official UNSW site, and cannot guarantee data accuracy or
reliability.
</Typography>
<Typography gutterBottom variant="body2">
<Typography gutterBottom variant='body2'>
If you find an issue or have a suggestion, please{' '}
<Link href="https://forms.gle/rV3QCwjsEbLNyESE6" target="_blank">
<Link href='https://forms.gle/rV3QCwjsEbLNyESE6' target='_blank'>
let us know
</Link>
.
Expand Down
13 changes: 6 additions & 7 deletions onboarding.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Onboarding

Welcome to CSESoc Projects and the Notangles team! This page will come in handy when you’re running Notangles locally, and working on your own features.
Welcome to DevSoc and the Notangles team! This page will come in handy when you’re running Notangles locally, and working on your own features.

## Your setup

Expand Down Expand Up @@ -37,14 +37,13 @@ Before you start, make sure that you have the following software installed.
- [Docker](https://www.docker.com/) (only needed if you are working on the back-end)
- [Instructions if you’re using WSL on Windows](https://docs.microsoft.com/en-us/windows/wsl/tutorials/wsl-containers)


## Getting the source code

We manage our source code with a version control system called [Git](https://git-scm.com/). Every time we *commit* new code, it gets added to a history of commits, so we can get old code back if needed. This code is then hosted on [GitHub](https://github.com/csesoc/notangles), so any code you *push* is backed up, and can be *pulled* by other team members. Git has other features like branches, which allow us to work on different versions of the same codebase at the same time, and merge them together later.
We manage our source code with a version control system called [Git](https://git-scm.com/). Every time we _commit_ new code, it gets added to a history of commits, so we can get old code back if needed. This code is then hosted on [GitHub](https://github.com/devsoc-unsw/notangles), so any code you _push_ is backed up, and can be _pulled_ by other team members. Git has other features like branches, which allow us to work on different versions of the same codebase at the same time, and merge them together later.

First of all, make sure that you have been added to the [Notangles repository](https://github.com/csesoc/notangles) on GitHub. While anyone can read our open-source codebase, you’ll need permissions to push changes.
First of all, make sure that you have been added to the [Notangles repository](https://github.com/devsoc-unsw/notangles) on GitHub. While anyone can read our open-source codebase, you’ll need permissions to push changes.

Once you’re in, summon a terminal and clone the repository by running `git clone [email protected]:csesoc/notangles.git`. (You can also use GitHub Desktop.) After that, navigate into the newly-cloned repository by running `cd notangles`.
Once you’re in, summon a terminal and clone the repository by running `git clone [email protected]:devsoc-unsw/notangles.git`. (You can also use GitHub Desktop.) After that, navigate into the newly-cloned repository by running `cd notangles`.

Then, run `cd client && npm install && cd ../server && npm install && cd ../scraper && npm install && cd ..`, which installs all the dependencies that the project needs.

Expand Down Expand Up @@ -89,6 +88,6 @@ Then, push the branch to the Notangles repository by running `git push -u origin

When you’re done with the issue, [create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) on GitHub, then assign as reviewers the team lead, and members with experience in the area.

When your pull request has been approved and merged into the *dev* branch, you can archive the card on Trello. All archived cards can be referenced from “archived items”, under “more” in the Trello menu.
When your pull request has been approved and merged into the _dev_ branch, you can archive the card on Trello. All archived cards can be referenced from “archived items”, under “more” in the Trello menu.

As a side note, **make sure to always pull from *dev*** before you do any work! This is so you can get the latest code to work on, with all the new changes from other team members.
As a side note, **make sure to always pull from _dev_** before you do any work! This is so you can get the latest code to work on, with all the new changes from other team members.

0 comments on commit fdb6514

Please sign in to comment.