README.md

bjc-r EDC | Berkeley

The Beauty and Joy of Computing curriculum repository.

Cloning this Repo

All content for BJC Labs lives inside this repository.

git clone [email protected]:bjc-edc/bjc-r

The Awkward Forking History:

There are two primary bjc-r repositories.

• This repo (bjc-edc/bjc-r) contains the high school AP CSP course, Middle School, and spanish translations of curricula
• cs10/bjc-r is ued primary for CS10 at UC Berkeley. https://cs10.org/bjc-r
• beautyjoy/bjc-r is a mirror of this (bjc-edc/bjc-r) repository, just for hosting.

Viewing the Site

The public content is viewable at the following two locations:

• https://bjc.berkeley.edu/bjc-r
• https://bjc.edc.org/bjc-r

However, the repository is setup so that any fork can be run using GitHub pages. The main BJC repo can be viewed in a live state, here, or you can use your own fork by visiting the following url: http://[username].github.io/bjc-r/, where you replace [username] with your GitHub account name.

Running Your Own (Local) Server

While GitHub pages are convenient, you'll likely want to run your own web server to make viewing changes much more quick and easy. In order to view the labs, you'll need to have an Apache server running on your machine. Here are some simple instructions for a couple different platforms.

No matter the platform, you should server files from /bjc-r/ at the root of your server.

macOS and Unix

The easiest way to setup a server is to use a simple, built-in Python server.

1. cd bjc-r -- Ensure your current directory is at the root of bjc-r/
2. Execute ./run-server 2.1 This must be run from within bjc-r. 2.2 Press Control-C to end the server.
3. Navigate to http://localhost:8000/bjc-r in a browser.
4. That's it! :)

This server requires Python 3.

Windows

As long as you can install Python 3, you should be able to run the same script, either via PowerShell, or WSL, or some other means.

Contributing

Review the Contributing and Authorship Guide.

However, for the most part, all you need to do is write some HTML. To contribute:

1. Create your own fork of bjc-r.
2. Create a new branch for your feature.
3. Work away!
4. Create a pull request.
5. Get feedback on the pull request and make changes as needed.
6. Be super awesome! :)

Of course, submitting issues is always welcome and encouraged! These issues can be bugs, questions, improvements or anything you'd like to share.

UC Berkeley Deployment Process

The UC Berkeley version is the live branch of the repo beautyjoy/bjc-r on GitHub.

License

CC-BY-NC-SA 3.0