Skip to content

Latest commit

 

History

History
147 lines (120 loc) · 4.54 KB

01-01-initial_commit.md

File metadata and controls

147 lines (120 loc) · 4.54 KB
Raw

Unit 1

Chapter 1: Initial Commit

In this chapter, you will start a new project and commit the source code to GitHub.

Creating the New App

Open your Docker container from the appropriate rbenv-general Docker image (as discussed in the README.md file). In the shell window, go to the /home/winner/shared directory. To create a new app named after the current date, enter the following commands:

DATE=`date +%Y-%m-%d-%H%M`
rails new generic-rails-$DATE; cd generic-rails-$DATE

.gitignore file

Let's update the new project's .gitignore file. Edit this file, make the following changes, and then save the file.

  • At the beginning of the .gitgnore file, enter the following lines:
########################
# BEGIN:initial contents
########################
  • At the end of the .gitignore file, enter the following lines:
#######################
# END: initial contents
#######################

################################
# BEGIN: Windows files to ignore
################################
# FROM https://github.com/github/gitignore/blob/master/Global/Windows.gitignore

# Windows image file caches
Thumbs.db
ehthumbs.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

# Windows shortcuts
*.lnk
##############################
# END: Windows files to ignore
##############################

#############################
# BEGIN: OS X files to ignore
#############################
# FROM https://github.com/github/gitignore/blob/master/Global/macOS.gitignore

*.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
###########################
# END: OS X files to ignore
###########################

##############################
# BEGIN: Linux files to ignore
##############################
# FROM https://github.com/github/gitignore/blob/master/Global/Linux.gitignore

*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*
############################
# END: Linux files to ignore
############################

# NOTE: Comments MUST get their own dedicated lines and cannot be shared with that of the file name.

Gemfile

  • By default, your new Rails app uses SQLite as its database. The production environment uses PostgreSQL, which is not specified in the original Gemfile. Because Unit 1 focuses on the development environment, we'll leave the original contents of the Gemfile alone but label the contents for easy replacement later.
  • At the beginning of the Gemfile, enter the following lines:
####################
# BEGIN:initial gems
####################
  • At the end of the Gemfile file, enter the following lines:
###################
# END: initial gems
###################

Setting Up Git Locally

  • Enter the following commands in your shell window (providing your Git repository email address and name, respectively):
  git config --global user.email "you@example.com"
  git config --global user.name "Your Name"
  • Please note that you must repeat the above step every time you enter a new development environment or reset your Docker container. Until you do so, you are unable to git commit, and you will see an error message telling you to set these Git configurations when you attempt to do so.

GitHub Repository

  • In your shell window, cd into your project's root directory and enter the following commands:
git init
git status # Shows list of files in your project, starting with .gitignore
git add .
git commit -m "Initial commit"
  • In your web browser, go to GitHub and create a new repository with the same name as that of this new Rails app. Stick with the default options to avoid financial costs and merge conflicts. You will see instructions for making the initial push from your local machine to the GitHub repository.
  • Go to your generic-rails-* repository on GitHub and follow the instructions for pushing an existing repository from the command line.
  • After you have pushed your repository, refresh the above browser window. The instructions have been replaced with the source code of your new app.