Political Computer Science @ Berkeley Website

Our website is open source! There is a lot of info you need to know to contribute, including best practices when coding, the process of code reviews, and (especially if you're new to web dev or git) set up. Please read through this whole README if you would like to contribute to our package!

Setup

1. Make sure you have git installed. Then open a terminal in git bash (this should be an app on your computer).
2. Make sure you have node.js installed. You should install the long term support (LTS) version that is recommended. Please make sure your node version is at least 20.11.1 and your npm version is at least 10.7.0. You can check this by running the following command in git bash:

node -v && npm -v

3. Create a GitHub account and follow these steps for configuring git to your GitHub. Please make sure you've done these steps correctly. You can verify git is connected to the right account by running the following command in git bash. This should print out the name you set and the email address associated with your GitHub account.

git config --get user.email && git config --get user.name

4. Branch the repository. Please navigate to the repository code homepage and find the Fork button. Then create a fork with the default settings.
5. Clone your branch. Navigate to the directory you would like to have the files in in your terminal. If you're unfamiliar with how to do this, please see this guide. Once you are in the desired directory, you can likely clone your repository by running the below command. If you see the following error: fatal: repository 'https://github.com/<YOUR_GITHUB_USER_NAME>/PCS-Website.git' not found then you either didn't branch the repository correctly or named it something else than PCS-Website.

git clone https://github.com/<YOUR_GITHUB_USER_NAME>/PCS-Website.git

6. Install dependencies. Navigate to the newly-cloned package via terminal by running cd PCS-Website (or a different package name/path if you named it differently or switched directories). Once in PCS-Website, run the following command npm install && npm run dev
7. Make sure the site runs correctly. A link should appear in your terminal that looks like this Local: http://localhost:5173/. Open that link in your browser (keep in mind your link may not have 5173) at the end. You should see the current draft of the PCS website running!