Contributing

Adding your own/favourite quote

Prerequisites

1. You need Git installed with a GitHub Account for this.

2. Fork this repository.

3. Clone your forked repository.

git clone https://github.com/<your-github-username>/upright-quotes.git

4. Use any methods below.

5. Open a pull request. If you don't know how to do this, check out this article.

Method 1: By editing quotes.json

1. Go to backend/data directory.

2. Open quotes.json in a file editor.

3. Add your own quote. Check out more about json here.

Method 2: Using the uq.bat file's push command

Note: You still need Node.js and Yarn to do the add command.

1. Install the dependencies.

cd backend        # Go to backend folder
yarn              # Install dependencies

2. Run add command.

uq add

3. Fill in the details.

Modifying the backend or frontend code

This can be done by the traditional method of installing dependencies, modifying code, testing it and opening a pull request.