Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gubbih authored Nov 27, 2023
1 parent 6ca33a2 commit accc4dc
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,29 @@ The backend can be started by running the start script:
```console
yarn start
```

You can make youre own website or use our frontend that we have developed along with this backend. you can use our frontend from here https://github.com/5-semesterprojekt/Frontend.git
# 📜 Scripts

### `yarn start`
Starts the api, you would now be able to make calls, look at the api doc

### `yarn test`
Runs all tests (see [vitest](https://vitest.dev/) for more).

### `yarn martin`
**ToDo cahnge name**
Formats the code according to the [.prettierrc](https://github.com/5-semesterprojekt/Backend/blob/main/.prettierrc).

<br>
# :building_construction: Contribution

1. Make a branch from `main` using the suggested branch name from [Shortcut](https://app.shortcut.com/5-semester/stories/space/19/everything?team_scope_id=v2%3At%3A6536343c-3b19-48f3-96bd-e44481a7aefc%3A6536343c-ab85-4346-9338-ad967260f782). (i.e. feature/sc-{story number}/{feature-name})
2. Commit until the feature is "complete"
3. Run `yarn prettier` so code is formatted correctly
4. Make pull request to `main` and request a review
5. <ins>**Squash and merge**</ins> when all requirements are met

It is **HIGHLY** advisable, that you don't branch off secondary branches. Only branch off `main`.

# API Documentation

Expand Down

0 comments on commit accc4dc

Please sign in to comment.