Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 2.75 KB

README.md

File metadata and controls

73 lines (50 loc) · 2.75 KB
Raw

codecrafters-frontend

The front-end app that powers app.codecrafters.io.

Prerequisites

You will need the following things installed on your computer:

You can run tests locally without a backend server, but to use the app you'll also need an instance of codecrafters-io/core running. You can either run this against staging, or against a local instance of core. Visit the core repo for setup instructions.

Setup / Installation

  • git clone <repository-url> this repository
  • cd frontend
  • npm install
  • Copy .env.example to .env and fill in the values

Running / Development

Running against staging

  • Run BACKEND_URL="https://backend-staging.codecrafters.io" npm run start
  • View your app at http://localhost:4200

Running with or without FastBoot

  • FastBoot is enabled when running ember build --environment=production
    • Pre-rendering is done only for routes configured under prember section in ember-cli-build.js
  • FastBoot is enabled for all routes when running ember server
    • To disable it, run FASTBOOT_DISABLED=true ember server
    • Alternatively, append ?fastboot=false query parameter to each request URL
  • Add FASTBOOT_DISABLED=true to your local .env file to disable FastBoot completely
    • You can override it by passing FASTBOOT_DISABLED="" in the command line
  • NPM tasks start and start:ember run with FastBoot disabled
  • NPM tasks start:fastboot and start:ember:fastboot run with FastBoot enabled

Running tests

  • Run make serve, ensure your server is running
  • View your tests at http://localhost:4200/tests/index/html?moduleId=abcd.
  • Select the module(s) you want to run from the dropdown at the top right of the page & click "Apply" to run tests.
  • To run all tests, remove the ?moduleId=abcd query parameter from the URL.

Linting

  • npm run lint
  • npm run lint:fix

Analyzing bundle size

  • Run ANALYZE_BUNDLE=true ember server --environment=production

Building

  • npm exec ember build (development)
  • npm run build (production)

Deploying

  • This app is automatically deployed to app.codecrafters.io when a commit is merged into main.
  • Each branch is also deployed to a preview URL via Vercel.