Skip to content

clairedross/learn

 
 

Repository files navigation

learn.adacore.com

Sources for AdaCore's learn.adacore.com website


Typescript Test Suite Sphinx Plugin Tests Sphinx Content Tests

Requirements

This project requires Vagrant and VirtualBox

Getting started

To setup for development run:

$ vagrant up

This will spin up three vms:

web: Is the the build system for the frontend web content. This includes the webpack build system and sphinx build.

server: Is the backend server with the widget API.

epub: Is the publishing server. This includes all packages needed to generate the learn website.

To build and start the development server for the frontend, run:

$ vagrant ssh web

# The following commands will be run inside the vm

$ source /vagrant/venv/bin/activate
$ cd /vagrant/frontend
$ yarn run dev

This will run webpack on the typescript and scss, then sphinx for the rst using make local which will point the widgets at 127.0.0.1:8000

You can then point your browser on your host to 127.0.0.1:8080 to see the learn website being served from vagrant.

To build and start the development server for the backend, run:

$ vagrant ssh server

# The following commands will be run inside the vm

$ cd /vagrant
$ source venv/bin/activate
$ ./dev_server.sh

You can use ctrl-c to quit the bash script which will kill both the flask and celery processes.

To build and start the publishing server, run:

$ vagrant ssh epub

# The following commands will be run inside the vm

$ cd /vagrant
$ source venv/bin/activate
$ make site

This will build the content for the learn website. You can find it in the /vagrant/frontend/dist directory.

About

Sources for learn.adacore.com

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ada 92.5%
  • Python 3.7%
  • TypeScript 2.6%
  • SCSS 0.5%
  • Makefile 0.3%
  • HTML 0.3%
  • Other 0.1%