thinkful-ed / full-stack-template

Thinkful Full Stack Template

A template for developing and deploying full stack JavaScript apps.

Getting started

Setting up a project

• Move into your projects directory: cd ~/YOUR_PROJECTS_DIRECTORY
• Clone this repository: git clone https://github.com/Thinkful-Ed/full-stack-template YOUR_PROJECT_NAME
• Move into the project directory: cd YOUR_PROJECT_NAME
• Install the dependencies: npm install
• Create a new repo on GitHub: https://github.com/new
  • Make sure the "Initialize this repository with a README" option is left unchecked
• Update the remote to point to your GitHub repository: git remote set-url origin https://github.com/YOUR_GITHUB_USERNAME/YOUR_REPOSITORY_NAME

Working on the project

• Move into the project directory: cd ~/YOUR_PROJECTS_DIRECTORY/YOUR_PROJECT_NAME
• Run the development task: npm run dev
  • Starts a server running at http://localhost:8080
  • Automatically rebuilds when any of your files change

Proxying

In development, the full stack template works by proxying requests from port 8080 to the server or the client. Any requests to routes which start with /api/, (for example, /api/foo, or /api/foo/bar) will be sent to the server. All other requests, will serve the client.

tl;dr Make sure your API endpoints start with /api.

Installing dependencies

Client-side dependencies should be installed into the client directory:

cd ~/YOUR_PROJECTS_DIRECTORY/YOUR_PROJECT_NAME/client
npm install --save dependency-name

Server-side dependencies should be installed into the server directory:

cd ~/YOUR_PROJECTS_DIRECTORY/YOUR_PROJECT_NAME/server
npm install --save dependency-name

Deployment

Requires the Heroku CLI client.

Setting up the project on Heroku

• Move into the project directory: cd ~/YOUR_PROJECTS_DIRECTORY/YOUR_PROJECT_NAME
• Create the Heroku app: heroku create PROJECT_NAME

Deploying to Heroku

• Push your code to Heroku: git push heroku master