Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI with GitHub Actions, update README.md #15

Merged
merged 1 commit into from
Jul 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: CI

on:
pull_request:
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3
with:
ref: ${{ github.event.release.target_commitish }}
fetch-depth: 0

- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
registry-url: https://npm.pkg.github.com

- name: Install dependencies
run: npm ci

- name: Check types
run: npm run check-types

- name: Run linter
run: npm run lint

- name: Run tests
run: npm run test
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Then clone it, install the dependencies, and you are ready to run the applicatio

The app will be available at `http://localhost:3000/`

### Features
- Pre-configured with CSS-in-JS styling using Emotion.js
- Pre-configured with code quality tools: ESLint, Prettier, TypeScript, Jest, etc.
- File-based routing based on TanStack Router
- CI based on GitHub Actions

### Scripts

- `npm start` - launches the application
Expand All @@ -18,7 +24,6 @@ The app will be available at `http://localhost:3000/`
- `npm run check-types` - launches type checking process using TS compiler
- `npm run prepare` - installs pre-commit hooks


### How to contribute

Everyone is welcome to contribute, improve or enhance this template. Whether you're a seasoned developer or just starting out, your input is valuable.
Expand Down
Loading