Skip to content

Latest commit

 

History

History
76 lines (63 loc) · 2.68 KB

setup.md

File metadata and controls

76 lines (63 loc) · 2.68 KB
Raw

Set up

Follow the instructions below to install, build, and run the Aura App locally in less than 15 minutes.

Install the Aura App and dependencies

  1. Fork repository and clone it locally
  2. Setup Environment
  3. Install project dependencies: npm install
  4. Replace the urlname Field (CHAPTER_URL_NAME) here
  5. Compiles and hot-reloads for development: npm run serve
  6. Update Meta Tag, Title Tag and Google Analytics Code from Basic Info, manifest.json and Resources
  7. For the production: npm run build and then one dir will be created dist
  8. For testing: npm run test

Deploy your Web App on Firebase

  1. Setup Environment for the Firebase deployment
    • Install Firebase CLI: npm i -g firebase-tools or yarn global add firebase-tools
  2. Create Firebase account and login into Firebase CLI: firebase login
  3. Open Terminal/CMD/Powershell in your dir.
  4. Now type firebase login command in your Terminal/CMD/Powershell.
  5. Type firebase init.
  6. Select the project by using the arrow keys.
  7. Then Select the Firebase Hosting by using Spacebar and arrow key.
  8. Click No for Single page web app.
  9. Type dist.
  10. Some by default file will be created successfully.
  11. Run locally
    • firebase serve or npm run serve
  12. Build and deploy
    • firebase deploy

Directory structure

The diagram below is a brief summary of the directories within the project.

/
|---.firebase/
|---dist/
|---docs/
|---public/
|---node_modules/
|---src/
|   |---assets/
|   |---components/
|   |---config/
|   |---filters/
|   |---plugins/
|   |---views/
|
  • .firebase/ Firebase deployment related temporary file
  • dist/ is the directory to deploy to production.
  • public/ folder with all index.html, img, Favicon Icon, manifest.json data for the template.
  • docs/ documentation.
  • node_modules/ is the place of Node dependencies.
  • src/ is where you store all of your source code and do all of your development.

Build and serve

  1. Run locally
    • cd into the base directory
    • npm install
    • npm run serve
  2. Build for the Production
    • npm run build
  3. Deploy for Firebase
    • firebase deploy or yarn deploy

Next steps

Now that your Aura App is up and running, learn how to configure app for your needs, or how to deploy the app to the web.