Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 2.24 KB

README.md

File metadata and controls

74 lines (44 loc) · 2.24 KB
Raw

Web Application Template

This template provides a base for developing a web application which includes a ReactJS client-side application and an HTTP web server for serving both static content and an API emitting JSON (or another data format).

Technologies

Dependencies

  • nodejs

    brew install node

  • sbt

    brew install sbt

Getting Started

  1. Make sure you've followed the Getting Started Guide.

  2. Download the template

  3. Unzip the resulting download and move the contents of webapp/ to a directory of your choosing.

  4. cd webapp/

  5. Initialize your repository.

git init

  1. Add your first commit.
git add .
git commit -m "Initial structure per template."

  1. sbt

  2. reStart

  3. Navigate to http://localhost:8083 to see the front-end.

  4. Navigate to http://localhost:8083/api/hello to see a sample service response.

Development

  • Dynamically recompile as you make changes via: ~compile.
  • Dynamically restart the service as you make changes via ~reStart.

Front End Development

Changes to the front-end code will be applied as you make them, even if you only run the reStart command without the ~. If you make changes to the frontend build configuration and need to restart npm, you'll have to use reStop to stop the background npm process, then run reStart again to restart it.

There's a slight lag, but keep an eye on your sbt console for information regarding the front-end build.

Questions?

dev@allenai.org

Using Windows?

Running a Virtualbox with Ubuntu is recommended. Check out this guide for details.