Skip to content

Add status badges to README :3 #107

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.

Sign up for GitHub

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

Merged
hashmapenjoyer merged 1 commit into from
Apr 17, 2026
Merged

Add status badges to README :3 #107

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 19 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
# Getting Started

[![CodeQL](https://github.com/hashmapenjoyer/DJ-AMBER/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/hashmapenjoyer/DJ-AMBER/actions/workflows/github-code-scanning/codeql)
[![Format](https://github.com/hashmapenjoyer/DJ-AMBER/actions/workflows/format.yml/badge.svg)](https://github.com/hashmapenjoyer/DJ-AMBER/actions/workflows/format.yml)
[![Lint](https://github.com/hashmapenjoyer/DJ-AMBER/actions/workflows/lint.yml/badge.svg)](https://github.com/hashmapenjoyer/DJ-AMBER/actions/workflows/lint.yml)
[![Test](https://github.com/hashmapenjoyer/DJ-AMBER/actions/workflows/test.yml/badge.svg)](https://github.com/hashmapenjoyer/DJ-AMBER/actions/workflows/test.yml)

## Prereqs

Node.js and npm (comes w/node)
please please please download and use a version manager ([nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating))

## Running locally
After you clone this repo, cd into it and run ```nvm use``` to switch to the correct Node version.

Then, install your dependencies with ```npm install```. It'll probably take a while the first time.
After you clone this repo, cd into it and run `nvm use` to switch to the correct Node version.

Then, install your dependencies with `npm install`. It'll probably take a while the first time.

You can start the dev server with ```npm run dev```, after which the project should be available at [http:localhost:5173/](http://localhost:5173/)
You can start the dev server with `npm run dev`, after which the project should be available at [http:localhost:5173/](http://localhost:5173/)

## Git

The main branch is protected, and you can't push to it. When you want to make a change, your workflow will probably look like:

```git pull```
`git pull`

```git checkout -b your-branch-name```
`git checkout -b your-branch-name`

```git add/commit/blahblahblah```
`git add/commit/blahblahblah`

and once it's ready to get merged in,

```git push```
`git push`

and submit a pull request in the pull requests tab.

Expand Down Expand Up @@ -68,15 +76,15 @@ export default defineConfig([
// other options...
},
},
])
]);
```

You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:

```js
// eslint.config.js
import reactX from 'eslint-plugin-react-x'
import reactDom from 'eslint-plugin-react-dom'
import reactX from 'eslint-plugin-react-x';
import reactDom from 'eslint-plugin-react-dom';

export default defineConfig([
globalIgnores(['dist']),
Expand All @@ -97,5 +105,5 @@ export default defineConfig([
// other options...
},
},
])
]);
```
Loading