Skip to content
This repository has been archived by the owner on Jun 28, 2020. It is now read-only.

uclaacm/hackucla.com

Repository files navigation

hackucla.com

Setting up environment for the first time

Preferred IDE: VS Code

Overall Development Workflow

This workflow is for if you want to run the entire application using Docker.

  1. Navigate to the project directory
  2. Make sure your Docker Daemon is running. For Mac, you'll see the whale icon on the top right corner which is the daemon, so make sure that is running.
  3. Run docker-compose up --build when you've made changes to the code. Or omit the --build flag if you have made no changes.
  4. Go to http://localhost:3000/

React.js Development Workflow

It is often slow to do front-end development in a Docker container and wait for code to build. If you are only working on the frontend, run only the backend services through docker-compose, and run the frontend locally.

Steps:

  1. Comment out the client configs in docker-compose.yml.
  2. cd client
  3. npm install (do this only the first time or if you change client/package.json)
  4. npm start

Git Development Workflow

  1. git checkout -b <your-name>/<feature-name>
  2. Code until you hit a good checkpoint. Make sure there are no errors/broken builds.
  3. git status shows you what files you have changed.
  4. Commit your files
    • If you want to commit all modified files:
      git add -A
      
    • Otherwise to add the particular files you want to commit:
      git add <file1> <file2> <...>
      
  5. git commit -m "some commit message"
  6. Push your branch
    • For brand new branches:
      git push -u origin <branch name>
      
    • For previously pushed branches:
      git push
      
    • you can find your branch names with git branch

Pull Request Workflow

  • Make a new branch formatted <your-name>/<feature-name> to submit a pull request to master.

  • Notify team that a PR has been made :)

  • After a pull request is approved, rebase and squash commits before merging into master

    1. Checkout to master
    git checkout master
    1. Pull the most recent changes from master
    git pull
    1. Check into the branch of the PR
    git checkout <your branch name>
    1. Rebase and squash commits:
    git rebase master
    1. Push changes to GitHub.
    git push -f

    Do NOT force push to other people's branches or shared branches

Documentation

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published