Skip to content

Latest commit

 

History

History
 
 

phoenix-ng

README.md

Phoenix application

Build and run

This is an Angular application, so you will need to have Node.js and Angular CLI installed locally.

You can follow this guide to set up your local environment.

Once everything is set up, run ng serve from the command line in the project directory for a dev server. Then navigate to http://localhost:4200/ from your browser.
The app will automatically reload if you change any of the source files.

Components

This application uses components from the phoenix-ui-components package.

Event display

This application uses the phoenix-event-display package (source) for all event display functionality. You can either use the npm package as is (through npm install phoenix-event-display).

Or symlink the local version of the package (for development) by following the steps below.

Development flow (with phoenix-event-display)

You can either use lerna and follow the development guide from the root README or manually symlink the Phoenix event display with the Angular app following the instructions below.

From the project repository directory.

## Symlink the event display which will let us use the local version of the phoenix-event-display package
cd packages/phoenix-event-display
yarn link
cd ../phoenix-ng
yarn link "phoenix-event-display"

## Run the event display in development mode
cd ../phoenix-event-display
yarn start

## Run the Angular app
cd ../phoenix-ng
yarn start

Now any changes in the phoenix-event-display package (source) will build the package and the Angular app will pick up the changes made to the event display.

Deploy the application

In order to make a version of Phoenix which can be deployed to your server, from the packages/phoenix-ng directory, run the following command:

yarn deploy:web

You can then copy the files generated in ./docs to your server e.g. with:

rsync -avz docs/ your-server.net:path/to/website

Deploy with a specific event

Phoenix can also be deployed as a single page application with a specific event. To do that.

  1. Copy the event data to ./projects/phoenix-app/src/assets (or you can use a URL instead)
  2. Specify the event data type and file path (or URL) in ./projects/phoenix-app/event-config.json
  3. Lastly, in the packages/phoenix-ng directory, run the command: yarn deploy:web:single

The deployed application will be in ./docs which can be copied directly to a server.