Skip to content

Latest commit

 

History

History
105 lines (77 loc) · 4.36 KB

CONTRIBUTING.md

File metadata and controls

105 lines (77 loc) · 4.36 KB
Raw

Contributing

We are currently in the V2 Milestone. Take a look at the V2 Column in the Project Page to see our priorities. You are more than welcome to contribute any PR regardeless if it's listed or not.

How to run locally

requirements:

  • node (for less)
  • phantomjs (for running client tests) npm install -g phantomjs
  • export SBT_OPTS = "-Xms512M -Xmx1536M -Xss1M -XX:+CMSClassUnloadingEnabled"
  • sbt
  • docker (for deploying)
sbt
> sbtRunner/reStart
> ~server/reStart

open http://localhost:9000

Structure

.
├── api                 | autowire api (rpc server <=> browser)
|                       |   models for server <=> sbt (akka-remote)
├── balancer            | distribute load based on sbt configuration
├── bin                 | scalfmt runner
├── build.sbt           | build definition
├── client              | Scala.js & scalajs-react code for the frontend 
├── codemirror          | Codemirror facade
├── demo                | cool examples to try in scastie
├── deployment          | production configurations
├── docker              | Dockerfile for sbt images
├── instrumentation     | Worksheet implementation
├── project             | build extras like Deployment or Scala.js packaging and plugins
├── runtime-dotty       | see `runtime-scala`
├── runtime-scala       | methods exposed inside scastie
├── sbt-runner          | remote actor communicating with sbt instance over I/O streams
├── sbt-scastie         | sbt plugin to report errors and console output with the `sbt-api` model 
├── server              | web server
└── utils               | read/writte files

High-Level Architecture

                                                                            +-----------------------------------------+
                                                                           +-----------------------------------------+|
 Scala.js Client     run/save/format                                      +-----------------------------------------+||
+-----------------+  AutowireApi      +---------------------+             |    SbtActor               Sbt(Proccess) |||
|      AppBackend |  (HTTP)           | +------------+      | akka-remote |   +----------+            +-----------+ |||
|      +--------+ +-----------------> | |LoadBalancer| <--------------------> |          |            |           | |||
|      |        | |                   | +------------+      |             |   |          |            |           | |||
|      |        | |                   |                     |             |   |          |  <----->   |           | |||
|      |        | |                   | SnippetContainer(DB)|             |   |          | I/O Stream |           | |||
|      |        | |                   |                     |             |   |          |            |sbt-scastie| |||
|      |        | | <-----------------+ oauth               |             |   |          |            |           | |||
|      +--------+ |  SnippetProgress  | static ressources   |             |   +----------+            +-----------+ |||
+-----------------+  (sse/websocket)  +---------------------+             |                                         ||+
                                                                          |                                         |+
                                                                          +-----------------------------------------+

Editor: http://asciiflow.com/

Let's talk

If you have any questions join us in the gitter channel

How to deploy

Requirements

  1. To deploy the application to the productions servers (scastie.scala-lang.org) you will need to have ssh access to the following machine:

Those people have access:

  • @MasseGuillaume
  • @heathermiller
  • @julienrf
  • @jvican
  • @olafurpg

  1. You need to be a member of the scalacenter on dockerhub: https://hub.docker.com/u/scalacenter

  2. dodocker login

  3. bump the version in build.sbt

  4. tag and commit the new version

  5. Run this command locally: sbt deploy

  6. Make sure everything went well: https://scastie.scala-lang.org

Running with docker locally

docker run --network=host scalacenter/scastie-sbt-runner:0.16.0