Skip to content

Website refactor away from js and react router

Notifications You must be signed in to change notification settings

aidansunbury/website-new

 
 

Repository files navigation

Codify Website

A static website that provides information to potential Codify members and clients.

Currently deployed at https://codifyberkeley.org/

Contributing

Contributions are always welcome!

Branching Strategy: Create a branch, make changes, and submit a pull request (PR) to the main branch. PRs should include a clear title, description, and reference to the related issue.

Branch naming convention: When you create a branch from master, name it [initials_page/feature]. For example, ES_home or ES_navbar.

If the commit is related to an issue or pull request, include references to them: eg. "Fix #123" to indicate that the commit resolves the issue.

Run Locally

To start, install all dependencies locally

  yarn install

then run the frontend

  yarn start

Deployment

  1. Run the site locally to make sure everything is working as expected
  yarn start
  1. Push or merge updates into the master branch
  2. To build the site and publish it to GitHub Pages run
  npm run deploy
  1. IMPORTANT immediately after pushing the updates, go to settings -> pages -> Custom domain an update the domain to codifyberkeley.org

  2. It may take a second to run a DNS check, but once that is done, visit the site live and make sure the updates are reflected.

Tech Stack

TailwindCSS: The website was initially created using vanilla css, but for better overall maintainability, please write all future code using TailwindCSS.

ReactJS: JavaScript library for building user interfaces.

React-Bootstrap: CSS framework of Bootstrap and replaces any existing JavaScript with strictly React components.

Material UI: any library of React UI components that implements Google's Material Design.

About

Website refactor away from js and react router

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 63.5%
  • TypeScript 21.9%
  • CSS 9.7%
  • HTML 4.9%