Skip to content

local.md

Latest commit

 

History

History
42 lines (31 loc) · 2.42 KB

local.md

File metadata and controls

42 lines (31 loc) · 2.42 KB
Raw

Local

Follow these steps to set up the project locally.

Dependencies

You will need the following things properly installed on your computer.

Steps

  • git clone <repository-url> this repository
  • cd open-event-frontend

Note : If you want to contribute, first fork the original repository and clone the forked repository into your local machine followed by cd into the directory

git clone https://github.com/USERNAME/open-event-frontend.git
cd open-event-frontend
  • yarn
  • cp .env.example .env
  • yarn l10n:generate

Important Notes

  • Open Event Frontend supports FastBoot which is disabled for the development environment and is controlled by the flag FASTBOOT_DISABLED in the .env file.

  • Only for Mac users :- If while running yarn l10n:generate you encounter Get-Text Finding Error or Ember-l10n Missing Dependencies. Please use this before running yarn l10n:generate again :

brew reinstall gettext
brew link --force gettext

  • By default, the .env.example file specifies the API_HOST as https://open-event.dokku.fossasia.org which is a test deployment of the open-event-server. If you intend to work on just the frontend, this is sufficient. If however, you intend to work on issues which involve both the frontend and the backend, you must have the open-event-server already up and running. Please install and set it up first before changing the URL for API_HOST to http://localhost:5000 and proceeding to run the frontend.

  • By default, the environment.js file specifies the webAppGenerator as https://open-event-wsgen-dev.herokuapp.com which is a test deployment of the open-event-wsgen. If you intend to work on just the frontend, this is sufficient. If however, you intend to work on issues which involve both the frontend and the website generator, you must have the open-event-wsgen already up and running. Please install and set it up first before creating a constant URL for WEB_APP_GENERATOR_HOST to http://localhost:3000 in .env and proceeding to run the frontend.

Running / Development