Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update README.md #1

Merged
merged 10 commits into from
Nov 7, 2024
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
44 changes: 44 additions & 0 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Website Checks

on:
pull_request:
branches:
- main
- staging
push:
branches:
- main
- staging

jobs:
lint:
name: Check formatting
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
- name: Install Yarn
run: npm install yarn --global
- name: Install dependencies
run: yarn install
- name: Check formatting with Prettier
run: yarn lint:prettier
build:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
- name: Install Yarn
run: npm install yarn --global
- name: Install dependencies
run: yarn install
- name: Build website
run: yarn build

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ dist-ssr
*.njsproj
*.sln
*.sw?

*.tsbuildinfo

51 changes: 2 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,3 @@
# React + TypeScript + Vite
# Wildhacks 2025 Website
Wildhacks is Northwestern's student run hackathon, this year taking place from April 4-6. This is the repo for the front-facing website. We use React/Vite and Sass and host using GitHub pages and Vercel.

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

- Configure the top-level `parserOptions` property like this:

```js
export default tseslint.config({
languageOptions: {
// other options...
parserOptions: {
project: ['./tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: import.meta.dirname,
},
},
})
```

- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
- Optionally add `...tseslint.configs.stylisticTypeChecked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:

```js
// eslint.config.js
import react from 'eslint-plugin-react'

export default tseslint.config({
// Set the react version
settings: { react: { version: '18.3' } },
plugins: {
// Add the react plugin
react,
},
rules: {
// other rules...
// Enable its recommended rules
...react.configs.recommended.rules,
...react.configs['jsx-runtime'].rules,
},
})
```
Binary file modified bun.lockb
Binary file not shown.
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
"dev": "vite",
"build": "tsc -b && vite build",
"lint": "eslint .",
"preview": "vite preview"
"preview": "vite preview",
"lint:prettier": "prettier --list-different src",
"lint:format": "prettier --write src"
},
"dependencies": {
"react": "^18.3.1",
Expand All @@ -23,6 +25,7 @@
"eslint-plugin-react-hooks": "^5.1.0-rc.0",
"eslint-plugin-react-refresh": "^0.4.12",
"globals": "^15.9.0",
"prettier": "^3.3.3",
"typescript": "^5.5.3",
"typescript-eslint": "^8.7.0",
"vite": "^5.4.8"
Expand Down
1 change: 0 additions & 1 deletion src/App.css
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@

12 changes: 6 additions & 6 deletions src/App.tsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { Header } from './components/Header/Header.tsx';
import { Footer } from './components/Footer/Footer.tsx';
import { Navigation } from './components/Navigation/Navigation.tsx';
import { SampleSection } from './components/Sections/SampleSection.tsx';
import { MainWrapper } from './components/MainWrapper/MainWrapper.tsx';
import { Header } from "./components/Header/Header.tsx";
import { Footer } from "./components/Footer/Footer.tsx";
import { Navigation } from "./components/Navigation/Navigation.tsx";
import { SampleSection } from "./components/Sections/SampleSection.tsx";
import { MainWrapper } from "./components/MainWrapper/MainWrapper.tsx";

export const App = () => {
return (
Expand All @@ -15,7 +15,7 @@ export const App = () => {

<Footer />
</MainWrapper>
)
);
};

export default App;
15 changes: 6 additions & 9 deletions src/components/Footer/Footer.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import React from 'react';
import './Footer.scss';
import React from "react";
import "./Footer.scss";

export const Footer: React.FC = () => {
return (
<div>
some words
</div>
);
interface IFooter {}

export const Footer: React.FC<IFooter> = () => {
return <div>some words</div>;
};

export default Footer;

15 changes: 6 additions & 9 deletions src/components/Header/Header.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import React from 'react';
import './Header.scss';
import React from "react";
import "./Header.scss";

export const Header: React.FC = () => {
return (
<div className="header__box">
some words
</div>
);
interface IHeader {}

export const Header: React.FC<IHeader> = () => {
return <div className="header__box">some words</div>;
};

export default Header;

12 changes: 6 additions & 6 deletions src/components/MainWrapper/MainWrapper.scss
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
@use "../../shared/colors";

.wrapper__div {
display: flex;
flex-direction: column;
background-color: colors.$global-sky-blue;
width: 100vw;
height: 100vh;
padding: 1em;
display: flex;
flex-direction: column;
background-color: colors.$global-sky-blue;
width: 100vw;
height: 100vh;
padding: 1em;
}
17 changes: 8 additions & 9 deletions src/components/MainWrapper/MainWrapper.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
import React from 'react';
import './MainWrapper.scss';
import React from "react";
import "./MainWrapper.scss";

export const MainWrapper: React.FC = ({children}) => {
return (
<div className="wrapper__div">
{children}
</div>
);
interface IMainWrapper {
children: React.ReactNode;
}

export const MainWrapper: React.FC<IMainWrapper> = ({ children }) => {
return <div className="wrapper__div">{children}</div>;
};

export default MainWrapper;

15 changes: 6 additions & 9 deletions src/components/Navigation/Navigation.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import React from 'react';
import './Navigation.scss';
import React from "react";
import "./Navigation.scss";

export const Navigation: React.FC = () => {
return (
<div>
some words
</div>
);
interface INavigation {}

export const Navigation: React.FC<INavigation> = () => {
return <div>some words</div>;
};

export default Navigation;

15 changes: 6 additions & 9 deletions src/components/Sections/SampleSection.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import React from 'react';
import './SampleSection.scss';
import React from "react";
import "./SampleSection.scss";

export const SampleSection: React.FC = () => {
return (
<div>
some words
</div>
);
interface ISampleSection {}

export const SampleSection: React.FC<ISampleSection> = () => {
return <div>some words</div>;
};

export default SampleSection;

12 changes: 6 additions & 6 deletions src/main.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { StrictMode } from 'react'
import { createRoot } from 'react-dom/client'
import App from './App.tsx'
import './index.css'
import { StrictMode } from "react";
import { createRoot } from "react-dom/client";
import App from "./App.tsx";
import "./index.css";

createRoot(document.getElementById('root')!).render(
createRoot(document.getElementById("root")!).render(
<StrictMode>
<App />
</StrictMode>,
)
);
14 changes: 7 additions & 7 deletions src/shared/colors.scss
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
$global-dark-green: #269449;
$global-light-green: #67E67C;
$global-cloud-blue: #AFD5F0;
$global-sky-blue: #ACE3EE;
$global-yellow-1: #FBE369;
$global-yellow-2: #D3914A;
$global-brown: #684C28;
$global-rocks: #9E9282;
$global-light-green: #67e67c;
$global-cloud-blue: #afd5f0;
$global-sky-blue: #ace3ee;
$global-yellow-1: #fbe369;
$global-yellow-2: #d3914a;
$global-brown: #684c28;
$global-rocks: #9e9282;
Loading