TL;DR

Running the following commands in a terminal will

• create a workspace
• install dependencies
• build packages
• create a .env file
• render sample content
• create a registration file
• run 10x Resume in watch mode

Setup

1. mkdir ~/10xresume && cd ~/10xresume
   git clone https://gitlab.com/10xresume/dev
   cd dev
   just

   The default just target tries to run all the steps described in this section of the documentation in one go. If it fails in a new workspace the most likely reason is some required component is missing. Installing it and running just again will restart the process.

   After a minute or so the last step of the just command will start a development server in watch mode where it will run indefinitely.

Wait

2. After a few moments, you will see a message of the form

   @repo/App:dev: [0] 7:00:11 PM - Found 0 errors. Watching for file changes.

   When you see this the 10x Resume development server is ready for you to login.

Login

All Plaforms

3. Open another terminal and run the following commands to show the development server’s static link and password

   cd ~/10xresume/dev
   just link

   Sample output

   % just link
          link https://localhost:5173/?00000000#/l/7cCwTvv93tpJhnU44MwMuA
   static link https://localhost:5173/static?00000000#/l/7cCwTvv93tpJhnU44MwMuA
      password xxxxxxxxxxxxxxxxxxxx

   
   

4. Open the static link in a browser, enter the password and press SIGN IN to login. The browser will redirect to a welcome page.

   Note

   Opening the link will attempt to load content from Userbase.
   For now use the static link to test content locally served by vite.

Shortcut for OSX

3. On OSX the following commands will copy the password to the clipboard and open the static development link in a browser.

   cd ~/10xresume/dev
   just openstatic

   To login paste the password from the clipboard into the password field and press SIGN IN. The browser will redirect to a welcome page.