mcs-web

This is the repo for www.mysterycodesociety.com.

Technologies

Eleventy - static site generator
Liquid - templating language
Node - JavaScript runtime
npm - node package manager
GitHub - host of the git repository
Netlify - build, deploy, and host the website

Local Development

Environment Setup

To develop locally, you will need to work on a computer with the following tools:

Terminal, Shell, or Console application.
git for version control
Node and npm
A Text Editor of your choice, e.g. Sublime Text (recommended), Textmate, VS Code
A browser of your choice, e.g. Chrome, Firefox, Edge, Safari

Below, you will find more specific instructions for your operating system.

On MacOS

Terminal is a shell that comes pre-installed on Macs. Find it in the Application folder and open it.
Install homebrew, which you will use to install Node.
Check if brew is installed by running brew -v in Terminal.
Install node in homebrew by running brew install node in Terminal.
Check if node and npm are installed by running node -v and npm -v in Terminal.
Open your browser.

On Linux

Linux usually comes pre-installed with at least one terminal emulator: gnome-terminal, konsole, xterm, eterm. Find it and open it.
Install git with sudo apt install git-all. Check it is installed by running git -v in terminal.
Install node with apt-get by running sudo apt install nodejs in your terminal.
Install npm with apt-get by running sudo apt install npm in your terminal.
Check if node and npm are installed by running node -v and npm -v in terminal.
Open your browser.

On PC

Install a git terminal emulator by downloading the build and installing it. Open it.
Install node and npm by downloading the Node.js installer.
In the git terminal, check to see if node and npm are in the path by running node -v and npm -v. If not, add them to your PATH environmental variable.
Open your browser.

Getting Started (The First Time)

GitHub account firsts

Create a GitHub account.
In your terminal, generate a SSH public key, following the steps in this guide. Copy the public key.
In GitHub, go to your Account Settings, and save the public key to your SSH and GPG keys.

GitHub Repository Firsts

Git Clone this repository onto your machine (see link for instructions).
Change your directory to the cloned repository: cd mcs-web in terminal.
Install dependencies: npm install in terminal.
Build the site for the first time (generating a _site directory) by running npx @11ty/eleventy in terminal.

Running the server

Run npx @11ty/eleventy --serve in terminal to start the app server.
Open your browser to a new tab and view the app at http://localhost:8080

Example Workflow

This workflow assumes you have already done all the 'Getting Started' pieces and are coming back to do work on this repo.

All code snippets below are commands to run in terminal.

Open terminal and change your directory until you are in this repository's directory.
Open your Text Editor, and open this repository as a project.
Pull down the latest code changes from GitHub.
```
git checkout master
git pull origin master
```
Create a new branch for your work.
```
git checkout -b my-new-branch-name
```
Install npm packages again, just in case they changed.
```
npm install
```
Create a new terminal window or tab and run the server there.
```
npx @11ty/eleventy --serve
```
Open your browser. View the app in a new tab at http://localhost:8080.
Do any work that you need to do. Save changes to the files, and eleventy should rebuild the site automatically and show the changes in the browser.

When you are done working, you can stage and commit your changes with git.

git add .
git commit -m 'Will add a good commit message about what this change does'

Push your branch to GitHub so you can open a new PR. If you cannot remember the current branch name, you can type git status to see the branch name.
```
git push origin my-new-branch-name
```
Go to the repository on GitHub. You should see the branch you just pushed. Click the 'Compare & pull request' button to make a new Pull Request.
On the Open a Pull Request page, type information a reviewer might need to review your work in the main body. On the right hand menu, use the Settings icon in the Reviewers section to tag reviewers. On the right hand menu, in the Label section add 'Code Review' as a label. Click to Create Pull Request'.

sponsor asks

Sponsor "Big Asks" cards will be shown at the top section of the sponsors page.

Leading text:

While our curriculum is designed challenge the minds of our students, there are some puzzles we don’t want them to have to solve. One of our core values has always been accessibility, and some of the barriers to getting into code have nothing to do with the code itself: lack of access to technology, transportation, or even an empty stomach can stand between a potential coder and their ambition to learn. We do not charge our students any kind of tuition, so it is only through the support of our generous sponsors that we are able to continue with our vision.

Pizza Sponsor
(one needed per class)
While pizza may seem like a perk, providing lunch helps students focus, and keeps us accessible for students who might not otherwise be able to take the class.
Location Sponsor
(one needed per class)
Monetary or donation of space
A regular home base that’s accessible to our students (with reliable wifi!) takes a lot of the guesswork out for our organizers (and the parents of our students!)
Graduation Sponsor
(one needed per full class)
Snacks, decorations and awards for our Graduation Celebrations, one of the most rewarding days of class for students, their families, and our volunteers.
Snack Sponsor
(one needed per class)
Light snacks are provided every week.
Sometimes fruit snacks are just the break you need to fix that bug.

Follow "big ask" cards with this text:

All sponsors are featured on our website, as well as getting frequent shout outs from the MCS social media, and an invitation to our Graduation Celebrations. Full Course Sponsors and Cornerstone Sponsors (Technology, Location, and Pizza Sponsors) get individual posts thanking them on our MCS facebook. Mystery Code Society is a registered 501(c)(3) and donations are tax deductible. Any sponsor donating over $250 will receive official documentation of the donation in their thank you letter.

Excited by our mission, but not sure how you can help us grow? Please contact us at [email protected] and one of our board members will contact you to discuss how we can work together to close the equity gap in tech.