Welcome to the source code for our team, Voices Everywhere, website! Our team is Ayelet Drazen, Baker Sharp, Krishan Nair, and Taylor Lallas.

Wite a description of our project here someday.

Write a description of CS147 here at some point.

Start by cloning/downloading this repo.

This project uses yarn as a package manager (it's basically the same thing as npm). Make sure you have the right yarn version with the command:

yarn --version

If this says anything other than 1.22.5, ask me about it. This is unlikely to be a problem, but I think it's the most likely thing to go wrong while setting this up assuming y'all have git working.

Next, install all the packages needed to run the website using this command:

yarn install

Now you can boot up the localhost version of the website with:

yarn start

This command will open up a browser window to the localhost website. Most changes are reflected live without having to restart the server or refresh the page.

After making any changes, push them up to the repo and let me know so I can deploy them. (Also I will need to add y'all as collaborators to the git repo so let me know the first time before you do this so we don't have to deal with pull requests.)

Deploying to the github pages site is very quick. Make sure the github url and baseUrl options are uncommented in docusaurus.config.js, and the Stanford options are commented out, so it looks like this:

// Url options to deploy to github pages
url: 'https://bakerfugu.github.io',
baseUrl: '/voices-everywhere-cs147/',

// Url options to deploy to stanford myth server
// url: 'http://web.stanford.edu',
// baseUrl: '/class/cs147/projects/ArtsandCulture/Voices/',

Then run the deploy command (replacing bakerfugu with your github username):

GIT_USER=bakerfugu yarn deploy

Deploying to the Stanford myth servers is a bit more complicated. First, we want push a build of the site to the "stanford" branch. To set this up, make sure the url and baseUrl options in docusaurus.config.js are set to the stanford ones, and the github pages options are commented out. It should look like this:

// Url options to deploy to github pages
// url: 'https://bakerfugu.github.io',
// baseUrl: '/voices-everywhere-cs147/',

// Url options to deploy to stanford myth server
url: 'http://web.stanford.edu',
baseUrl: '/class/cs147/projects/ArtsandCulture/Voices/',

Then run this terminal command (replace bakerfugu with your github username):

GIT_USER=bakerfugu DEPLOYMENT_BRANCH=stanford yarn deploy

That command will take a moment, so while that's happening open another terminal window and login to the myth server (replace bakers with your SUNET):

ssh [email protected]

Type in your password, then navigate to our team directory on the myth server:

cd /afs/ir/class/cs147/WWW/projects/ArtsandCulture/Voices

If you type ls now, you should see a bunch of random files from when we built the website last time. Get rid of them (make sure you haven't moved from the directory above when you do this, deleting other people's stuff would be very bad):

rm -r -d -v -f ./*

Our team directory should be empty now, so let's download the new build of the website. Make sure the yarn deploy from the other terminal window finished without throwing any errors. It's usually worth checking the stanford branch to see if all the files there are recent.

wget https://github.com/bakerfugu/voices-everywhere-cs147/archive/stanford.zip

Once we have the zip downloaded, unzip it:

unzip stanford.zip

The zip file makes a directory with all the build stuff in it, but we want all of that at the root level of our project folder, so move all the files inside of it one level up:

mv DIRECTORY_NAME/* .

You should be done now. Check http://web.stanford.edu/class/cs147/projects/ArtsandCulture/Voices/ to see if the changes show up!

This website is built using Docusaurus 2, a modern static website generator.