Merge pull request #9 from bluzky/setup-dev

Set up dev environment

.github/workflows/salad_ui.yml

@@ -0,0 +1,87 @@
+name: Elixir CI
+
+# Define workflow that runs when changes are pushed to the
+# `main` branch or pushed to a PR branch that targets the `main`
+# branch. Change the branch name if your project uses a
+# different name for the main branch like "master" or "production".
+on:
+  push:
+    branches: [ "master", "main", "staging", "dev", "setup-dev", "setting-up-tests"]  # adapt branch for project
+  pull_request:
+    branches: [ "master", "main", "staging", "dev", "setup-dev", "setting-up-tests"]  # adapt branch for project
+
+# Sets the ENV `MIX_ENV` to `test` for running tests
+env:
+  MIX_ENV: test
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Test on OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
+    strategy:
+      # Specify the OTP and Elixir versions to use when building
+      # and running the workflow steps.
+      matrix:
+        otp: ['26']       # Define the OTP version [required]
+        elixir: ['1.16.2']    # Define the elixir version [required]
+    steps:
+    # Step: Setup Elixir + Erlang image as the base.
+    - name: Set up Elixir
+      uses: erlef/setup-beam@v1
+      with:
+        otp-version: ${{matrix.otp}}
+        elixir-version: ${{matrix.elixir}}
+
+    # Step: Check out the code.
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    # Step: Define how to cache deps. Restores existing cache if present.
+    - name: Cache deps
+      id: cache-deps
+      uses: actions/cache@v3
+      env:
+        cache-name: cache-elixir-deps
+      with:
+        path: deps
+        key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-mix-${{ env.cache-name }}-
+
+    # Step: Define how to cache the `_build` directory. After the first run,
+    # this speeds up tests runs a lot. This includes not re-compiling our
+    # project's downloaded deps every run.
+    - name: Cache compiled build
+      id: cache-build
+      uses: actions/cache@v3
+      env:
+        cache-name: cache-compiled-build
+      with:
+        path: _build
+        key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-mix-${{ env.cache-name }}-
+          ${{ runner.os }}-mix-
+
+    # Step: Download project dependencies. If unchanged, uses
+    # the cached version.
+    - name: Install dependencies
+      run: mix deps.get
+
+    # Step: Compile the project treating any warnings as errors.
+    # Customize this step if a different behavior is desired.
+    - name: Compiles without warnings
+      run: mix compile --warnings-as-errors
+
+    # Step: Check that the checked in code has already been formatted.
+    # This step fails if something was found unformatted.
+    # Customize this step as desired.
+    - name: Check Formatting
+      run: mix format --check-formatted
+
+    # Step: Execute the tests.
+    - name: Run tests
+      run: mix test

.gitignore

@@ -25,4 +25,8 @@ salad_ui-*.tar
 # Temporary files, for example, from tests.
 /tmp/
 
-.DS_Store
+.DS_Store
+
+node_modules/
+
+/.vscode/

README.md

@@ -108,11 +108,21 @@ Here is how to start develop SaladUI on local machine.
 1. Clone this repo
 2. Clone `https://github.com/bluzky/salad_storybook` in the same directory with `SaladUI`
 3. Start storybook
-```
+```ex
 cd salad_storybook
 mix phx.server
 ```
 
+## Unit Testing
+
+In your project folder make sure the dependencies are installed by running `mix deps.get`, then once completed you can run:
+
+- `mix test` to run tests once or,
+- `mix test.watch` to watch file and run tests on file changes.
+
+To run the failing tests only, just run `mix test.watch --stale`.
+
+  It's also important to note that you must format your code with `mix format` before sending a pull request, otherwise the build in github will fail.
 
 ## List of components