Giter Site home page Giter Site logo

sidewalk-docker's Introduction

Project Sidewalk Docker Environment

This repository contains build files that can be used to launch a development environment for Project Sidewalk using Docker.

Usage instructions

  • Follow instructions to install Docker for your OS.

  • Install docker-compose.

  • Clone this repository:

    $ git clone https://github.com/tongning/sidewalk-docker.git
  • Obtain a database dump from the Project Sidewalk team and move it into docker/postgres, naming it sidewalk.sql:

    $ mv /path/to/databasedump.sql sidewalk-docker/docker/postgres/sidewalk.sql
  • Enter the repository folder and clone the Project Sidewalk platform:

    $ cd sidewalk-docker
    $ git clone https://github.com/ProjectSidewalk/SidewalkWebpage.git
  • Build and run:

    # Run with sudo if necessary
    $ docker-compose up

    First launch can take a long time for all components to download and build. Once completed, you should see a message like the following:

    Listening for HTTP on /0:0:0:0:0:0:0:0%0:9000
    

    Once you see this message, visit http://localhost:9000 to see the webpage.

    Important note:

    You may encounter errors related to failed downloads of Scala components. To resolve them, just quit (Ctrl+C) and rerun docker-compose up until all components download successfully. This is a known issue.

  • You are finished! Edit the code in the SidewalkWebpage folder, and the site will rebuild automatically. You can also connect a debugger to port 9999 on your local machine. We recommend using an IDE, such as IntelliJ.

Configuration notes

The docker-compose.yml file sets up three linked Docker containers - postgres, web, and grunt.

  • postgres hosts the sites PostgreSQL database, which stores users data, labels, and other information. If you need to view or modify database entries directly, you can do so by connecting a Postgres client (e.g. pgAdmin) to port 5432 on your host machine.
  • web runs the Scala web application using Activator.
  • grunt runs the nodejs "grunt" module on the source files. It watches for changes in Javascript files and copies Javascript code to the correct locations.

sidewalk-docker's People

Contributors

tongning avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.