OCaml Practice Exercises

This repository contains practice exercises for learning OCaml. You can use this repository on various platforms: GitHub Codespaces, Replit, Learn Ocaml and locally with Jupyter Notebook or directly on your machine.

Getting Started

Prerequisites

• Git
• Docker (for local Jupyter Notebook setup)

Clone the Repository

git clone https://github.com/divyankachaudhari/ocaml-practice-exercises.git
cd ocaml-practice-exercises

Available Exercises (for local, github codespaces and replit)

The exercises are located in the practice directory. Each exercise includes:

• work/impl.ml: Implementation template for you, the learner.
• answer/impl.ml: Reference solution.
• ex.ml: Function signatures and test cases.

Example usage practice/008: Run dune build --root . to compile and dune test --root . work to test your implementation against test cases.s

Exercise descriptions are in the exercises directory.

Running Locally

• Ensure the setup scripts have execute permissions:

  chmod +x setup_exercise.sh

1. Ensure OPAM and Dependencies Are Installed:

   opam init -y --disable-sandboxing
   eval $(opam env)
   opam switch create 4.14.0
   eval $(opam env)
   opam install -y dune ounit

2. Run the Setup Script:

   ./scripts/setup_exercise.sh

Using GitHub Codespaces

1. Open in GitHub Codespaces:

   • Navigate to your repository on GitHub.
   • Click the green "Code" button, select "Codespaces", and create a new codespace.

2. Setup the Environment:

   • Codespaces will automatically use the .devcontainer configuration to set up the environment.

3. Run Exercises:

• Ensure the setup scripts have execute permissions:

  chmod +x setup_exercise.sh

• Open the terminal in Codespaces and run:

  ./setup_exercise.sh

Using Replit

1. Import the Repository:

   • Go to Replit.
   • Click "Create", select "Import from GitHub", and enter your repository URL.

2. Setup the Environment:

   • Replit will use the replit.nix configuration to set up the environment.

3. Run Exercises:

   • Ensure the setup scripts have execute permissions:

     chmod +x setup_exercise.sh

   • Click the "Run" button on Replit to execute the setup script and follow the prompts:

     ./setup_exercise.sh

Using Jupyter Notebook

Ensure that you've cloned ocaml-practice-exercises and are now in the repository.

1. Navigate into jupyter folder

   cd jupyter

2. Build the Docker Image: One time setup

   docker build -t ocaml-jupyter .

3. Run the Docker Container

   docker run -p 8888:8888 -v $(pwd):/home/opam/work ocaml-jupyter

4. Access the Jupyter Notebook
   • After running the container, you should see output in the terminal that includes a URL. It will look something like this:

     http://127.0.0.1:8888/tree

   • Copy this URL and paste it into your web browser's address bar. This will open the Jupyter Notebook interface where you can start working with OCaml notebooks.

Using Learn OCaml Platform

We have also converted the exercises into the format that learn ocaml requires. Learn OCaml is a platform that can be used to learn ocaml - especially in classroom like environments.

• More information can be found here: https://ocaml-sf.org/learn-ocaml/
• Deploy an instance from documentation here: https://learn-ocaml.readthedocs.io/en/master/howto-deploy-a-learn-ocaml-instance/

learn-ocaml-repository is the folder you can use to deploy these set of exercises.

docker run --platform linux/amd64 --rm -v <your-path>/ocaml-practice-exercises/learn-ocaml-repository:/repository:ro -v learn-ocaml-sync:/sync -p 80:8080 --name learn-ocaml-server ocamlsf/learn-ocaml:master