/csxl-fullstack

Primary LanguageHTML

CSXL full-stack workshop setup!

Back-end

Howdy, hope you are doing having a wonderful day! Let's get started with this set up.

The basics

  1. Fork this repo by clicking the fork button on the top right corner.
  2. After that, clone your forked repo into your machine. By doing this:
    • Click on the green code button on your repository page.
    • Select HTTPS or SSH, and copy the link displayed to you.
    • Then, run git clone your@link in your terminal window!
  3. All of this being done, run cd csxl-fullstack/backend
  4. When you are in the backend directory, you are ready to install some essentials things!

Housekeeping

N.B. If you have Python 3 installed you might have to use python3 as opposed to python.

  1. Please follow the instructions in this link to install python and the necessary tools for this workshop. You can safely ignore the Zoom instructions.
  2. In the csxl-fullstack/backend directory, run python -m pip install -r requirements.txt.
  3. Then, run python -m uvicorn main:app --reload.

Sanity check!

  1. If everything is working properly, if you go to this url, you should see a "Hello World" message!

Front-end

Hello! Thanks for signing up for our workshop – I'm so excited! For now, let's walk through setting up your workspace.

The basics

  1. If you've made it here, you've possibly already forked this repository! If you haven't, do that now, and open it in your fav text editor (I'm using vscode)
  2. You will need Node.js and NPM installed on your system to run anything. First, check if you have both already by opening a terminal and running node -v and npm --v.
    1. If both of these produce numbers (>=14.0.0 for Node and >=5.6 for npm), you're all set!
    2. If not, download them here and follow the installation prompter. After download, return to step 2 to make sure it worked!

Housekeeping

  1. Let's get you into the right directory.
    1. If you're in vscode, you can right-click on the front-end directory and press 'open in integrated terminal'. Boom.
    2. (If you're in vscode or not), you can open a terminal and cd (change directory) into front-end. You can do this by first running pwd to make sure you're in the csxl-fullstack directory (what prints out should end with csxl-fullstack), then run cd front-end. This is a simple way to navigate directories via the command line!
  2. Now we're in the front-end directory. Here is where all of the starter code for the workshop is! What we're concerned with now is making sure you have all the dependencies we'll need installed.
    • To do this, run npm i. That's it! This magic command looks at the dependencies/dev dependencies listed in package.json and makes sure you have them installed locally.

Sanity check!

  1. Now, to make sure everything installed smoothly, let's test the two development environments we'll be using.
    1. We will be using Storybook to develop and test components. In the terminal, run npm run storybook to run the application. Go to the URL the command outputs (likely localhost6006), and make sure you see a Storybook page that begins with 'Hey, welcome to Storybook!' If you see this, you're golden.
    2. To start the development server for our web app, run npm start. This should start a local dev server (probably localhost3000) – go to this page, and you should see a pink/purple webpage that begins with 'Hello, dev!'
  2. If you were able to see these two environments, you're all set! If not, consider this a time to explore StackOverflow and/or come to the XL for help! (see the next section for more info)

You're done!

Nice work! I'm excited to meet and work with y'all – feel free to peruse the workspace if you'd like, but we will go through everything together on Thursday! Cheers!

Stay calm!

Don't worry if you got some errors, please stop by the XL (SN027) and we'll be more than happy to help you out.

Alternatively, you can email Felipe at yanaga@ad.unc.edu (back-end) and/or Claire at clairehh@live.unc.edu (front-end)!

Finally

If you have read this far, please email both of us with your name, year, pronouns, and any web dev experience (none is expected! we just want to gague where y'all's understanding is). Optionally, you can also send us a joke.

See you soon!