These instructions are written for a Mac setup. All tools listed should be installable or have alternatives on Windows/Linux, but the steps might be different from those listed.

1. Ensure you have been invited and can access the following pages

   1. Figma
   2. Slack (Turn notifications on)
   3. Google Calendar (Turn notifications on)
   4. Notion (if you’re reading this, you do!)
   5. Github
   6. Heroku
   7. Tailwind
   8. The app

2. Install dependencies

   Required:

   • Homebrew for Mac, Linux on Windows for Windows (requires restart)
   • Git
   • Deno
   • node.js
   • Docker
   • git lfs install && git lfs pull

   Optional (not needed if using Docker Quickstart):

   • Postgres.app
   • Redis (Windows: install Redis using the **Ubuntu** terminal)

3. Install tools

   • Postgres Client

     • If running with the docker setup, adminer will be running on http://localhost:8888 and you’ll see connection info printed to the console

       

     • Dedicated clients include Postico for Mac, PgAdmin for Mac & Windows, DataGrip (macOS and Windows), TablePlus (all OS)

   • Slack for mobile and desktop with notifications on
   • Visual Studio Code
     • Live Share
     • Deno Extension
     • https://marketplace.visualstudio.com/items?itemName=frigus02.vscode-sql-tagged-template-literals-syntax-only
   • Chrome Extensions (optional)
     • html.to.design
     • Cookie Editor
     • Preact Developer Tools
     • HTTP Headers
   • Github CLI
   • Heroku CLI

4. Clone the repository.

   https://github.com/Virtual-Hospitals-Africa/virtual-hospitals-africa

   git clone [email protected]:Virtual-Hospitals-Africa/virtual-hospitals-africa.git --recursive
   

5. Run ./setup.sh. If you missed any dependencies or are running Windows you may need to follow the steps manually to create the .env files correctly

   ./setup.sh
   

   Manual Local Setup

6. Run the project locally. You will see TLS errors. Those can safely be ignored for now

   deno task start
   

7. Access the application at https://localhost:8000. You should be prompted to log in via google.

   

8. If you could log in, you’re fully up! Try the workflows from Testing things out