teresa-m-knowles / quantified-self-fe

Quantified Self Front-end

Initial Setup

1. Clone this starter kit repository and rename the repository to quantified-self-fe in one command

git clone [e-mail]:turingschool-examples/qs-fe-starter-kit.git quantified-self-fe

2. Change into the quantified-self-fe directory

3. Remove the default remote (origin)

git remote rm origin

4. Create a new repository on GitHub named quantified-self-fe

5. Add your new repository remote - your remote URL and user name will be different in the command below

git remote add origin [e-mail]:<YOUR GITHUB NAME>/quantified-self-fe.git

6. Install the dependencies of the starter kit

npm install

7. Add, commit, and push up to your repository

git add .
git commit -m "Initial commit using starter kit"
git push origin master

Running the Server Locally

To see your code in action locally, you need to fire up a development server. Use the command:

npm start

Once the server is running, visit in your browser:

• http://localhost:8080/ to run your application.

You will need to make sure that your Quantified Self API is also running at http://localhost:3000

GitHub Pages Setup

This site will be served from GitHub Pages in production.

In order to see your application running on production:

1. From the command line, run npm run build.

2. Commit and push your application to GitHub.

3. Visit your repository on Github

4. Go to Settings

5. Under the Github Pages section of Options, select 'master' as your source and click Save

Be sure to npm run build and commit before each push to master. A few seconds after you push up, you should be able to see your application at https://your-github-username.github.io/quantified-self-fe.

Built With

• JavaScript
• jQuery
• Express
• Mocha
• Chai