bea9d0835b
* refactored Storybook UI * refactored Storybook UI * removed extra cards from the doc, added card for ui components * added hover behavior to doc page & made it look selected * separate storybook docs and tests * separating storybook tests and docs * fixed spelling errors in docs * Final round of edits for frontend, added backend folder architecture * Created CODE_OF_CONDUCT.md * Add code of conduct to contributing.md * doc changes * fixed broken links
45 lines
815 B
Plaintext
45 lines
815 B
Plaintext
---
|
|
title: Contributing
|
|
sidebar_position: 1
|
|
description: Learn how you can contribute to the project
|
|
sidebar_custom_props:
|
|
icon: TbTopologyStar
|
|
---
|
|
|
|
## Pre-requisites
|
|
|
|
Make sure that your [IDE is correctly setup](/contributor/local-setup/ide-setup) and that your backend is running on `localhost:3000`.
|
|
|
|
|
|
## Starting a new feature
|
|
|
|
Make sure your database is running on the URL provided in your `server/.env` file.
|
|
|
|
```bash
|
|
cd front
|
|
yarn
|
|
|
|
yarn start
|
|
```
|
|
|
|
## Regenerate graphql schema based on API graphql schema
|
|
|
|
```bash
|
|
yarn graphql:generate
|
|
```
|
|
|
|
## Lint
|
|
|
|
```bash
|
|
yarn lint
|
|
```
|
|
|
|
## Test
|
|
|
|
```bash
|
|
yarn test # run jest tests
|
|
yarn storybook:dev # run storybook
|
|
yarn storybook:test # run tests (needs yarn storybook:dev to be running)
|
|
yarn storybook:coverage # run tests (needs yarn storybook:dev to be running)
|
|
```
|