Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.26 KB

setup.md

File metadata and controls

54 lines (40 loc) · 2.26 KB

General Assembly Logo

react-auth-template

A front-end framework template for starting projects with a recent version of either the Rails API Template or the Express API Template.

Installation

  1. [Download]from https://github.com/ethanstrominger/event-finder-ultimate.
  2. Unzip and rename the template directory (unzip ~/Downloads/react-auth-template-master.zip).
  3. Move into the new project and git init.
  4. Replace the "homepage" field in package.json with your (public) Github account name and repository name.
  5. Install dependencies with npm install.
  6. git add and git commit your changes.
  7. Run the development server with npm start.

Deployment

Before deploying, you first need to make sure the homepage key in your package.json is pointing to the correct value. It should be the url of your deployed application.

To deploy you should first make sure you are on the master branch with a clean working directory, then you can run npm run deploy and wait to see if it runs successfully.

src/apiConfig.js

Just like in browser-template, this file will determine whether you're in a production or development environment and choose an API URL accordingly. Don't forget to replace the production URL with your deployed API's URL.

Tasks

Developers should run these often!

  • npm run nag: runs code quality analysis tools on your code and complains.
  • npm run make-standard: reformats all your code in the JavaScript Standard Style.
  • npm run start: generates bundles, watches, and livereloads.
  • npm run build: place bundled styles and scripts where index.html can find them
  • npm run deploy: builds and deploys master branch

License

  1. All content is licensed under a CC­BY­NC­SA 4.0 license.
  2. All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact legal@ga.co.