Home

Quote Vote

Quote Vote was built to enable anyone, anywhere to create a forum where they can share their knowledge and learn from others. The existing platforms all had problems, whether that was a system that could be gamed to exclude the people most in need of a place to have their voices heard, shady data collection practices, geographic limitations, or all of the above.

Table of Contents

• Requirements
• Installation
• Contributing

Requirements

• If working on a mac, you will need to have Xcode properly installed for your current OS version.

Installation

1. To run the backend locally, follow these instructions.

2. Clone the repository

   git clone https://github.com/scoreboardinc/quotevote-React.git && cd quotevote-React

3. Install dependencies

   npm install

4. Run the application

   npm start

Contributing

1. Clone the repo, this pull our dev branch. it's our default branch
   git clone https://github.com/QuoteVote/quotevote-React.git

2. Install node_modules
   cd quotevote-react && npm i

3. Check out a new branch, with dev- prefix
   git checkout -b dev-feature
   for example dev-eslint-fix

4. Do your work, check UI, run tests.

5. Make as many commits as you like. After each commit, push the branch back up to origin. git push origin dev-branchName
   As a note, if it's incomplete, add WIP to the git commit message first line.

   For example:

    WIP Linting files.
   
    Lint only some files
   
    Todo:
      - Lint more files
   

6. Once you are done with your work, make sure all test still pass, and that you have linted the files.
   npm run lint:check

• Make the adjustments needed so there is no warnings or errors.
• Ensure you can build without any problems.
  npm run build

7. Create your PR using pull request template.

See the deployed version on the netlify preview build. Wait for code review, feedback, or approval.

To see the preview build from Netlify, and scroll down to the bottom. Next to where it says "Deploy preivew", it says Details. If it's still building, it'll direct you to the netlify log of the build process. Once complete it will show a green check like the example below.

---

Read more in our wiki