Giter VIP home page Giter VIP logo

cs22-lean-2023's Introduction

Brown CS22 Spring 2023: Lean project

Directions for setting up GitPod

Before following these directions, you will need to sign up for a GitHub account if you don't have one already. This will be useful throughout the rest of your career at Brown CS. We strongly recommend picking a professional and identifiable username. For example, I'm robertylewis.

There are scattered reports that this might not work on some versions of Safari. If you run into trouble, try it in Chrome or Firefox before reporting to us.

  • Click on this link.
    • This will send you to Gitpod. Log in with your GitHub account.
    • If you are given a choice to open in your browser or locally, choose the browser option.
  • It will take a minute, but eventually, you'll see a VSCode interface in your browser. You should see:
    • A panel Terminal on the bottom. There will be some code running here at first. Let it finish before you do anything else; it's done when the last line is gitpod /workspace/leanclass (main) $.
    • A panel Explorer on the left that lets you browse directories and files.
    • A text editor panel in the middle.
    • A panel on the right, Lean Infoview.
  • Go back to the Gitpod home page. You'll see your new workspace there. Use the dropdown menu โ‹ฎ to:
    • Rename the workspace to something recognizable, like "Brown CS0220 Class Repository."
    • Pin the workspace. This is important: if you don't pin it and go two weeks without opening it, Gitpod will delete it!

You're all set up. In the future, you should bookmark your workspace URL and access it that way, or use the Gitpod home page. The link above will create a new workspace each time you click it. (This is why we recommend renaming your main workspace, to distinguish it from new ones.)

If at any point your workspace becomes unusable and you think you need a fresh start, you can click on the original link to get a new copy of the course workspace.

Directions for Setting up Logging

  1. Click on Extensions (or Ctrl + Shift + X) in the VSCode interface.

Click on Extensions

  1. Click the ... and select Install from VSIX.

Select Ellipsis

  1. Enter the following path and hit OK : /workspace/CS22-Lean-2023/save-to-firestore-0.13.1.vsix

  2. If prompted, restart VSCode.

Enabling logging is an optional feature that can greatly benefit our understanding of students' issues with assignments, leading to improvements for future students. This logging is completely anonymous, and is carried out only when a file is saved. The information logged is:

  • The version of Lean being used
  • The name and contents of the file being worked on.
  • An anonymous user-id, which is persistent, but not related to the users' identity.
  • The timestamp at which the log was generated.

Directions for updating

We will push more lecture demos and homework assignments to this project throughout the semester. To pull them into your Gitpod instance, follow these directions:

  • Open the terminal in Gitpod, if it is not already open.
  • Run the command scripts/pull-updates.

We will try not to let this happen, but occasionally, we might change files that you have edited yourself. The pull-updates script should notice this and not overwrite your changes. But if there are conflicts, you may have to reset your work. (Feel free to copy your changes to another file if you want.) Running the command scripts/reset-all and then pull-updates again should clean things up.

git: the fine print

This is a GitHub repository, and your workspace will interact with our course materials using git. We do not expect you to have any experience or knowledge of git beyond having a GitHub account. If you do know how to use git and would like to use proper version control in your workspace, you are welcome to, but our course staff is not responsible for helping! We document the setup here for your reference.

  • We will try our best not to modify files in the BrownCs22/Demos directory after we add them. This should minimize merge conflicts if you edit files there.
  • Official course materials, including lecture demos and homeworks, will be pushed to the main branch of this repository. You will have to pull these changes to your workspace.
  • The pull-updates script in your workspace will git stash any uncommitted changes you have, pull our updates, and git stash pop your changes back. If your changes conflict with ours, it will leave your project unmodified and print an error message. This script assumes you have not made any commits of your own; if you have, you're on your own!
  • The reset-all script resets all tracked files to the most recent commit.

cs22-lean-2023's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.