Skip to content

Latest commit

 

History

History
116 lines (87 loc) · 5.92 KB

README.md

File metadata and controls

116 lines (87 loc) · 5.92 KB
Raw

Run Tests Last Deploy Status Gitpod Ready-to-Code

QuestLists

QuestLists is a crowd-sourcing application that organizes lists of any sort. The crowd builds the lists, you say what you want to use from that list, and then use it as a normal checklist. At its heart, this is an n-state checklist application.

The intention is to use the crowd to build lists for games, inventories, shopping, music, videos, and more! Once the lists are built and created, you can add/remove your items from them. It uses the browser's caching for data, so you don't even have to login to use it (only for the same devise)!

NOTE: This is the frontend for QuestLists, with a firebase backend, by default. More backends will be developed separately.

Demo

This is the public code for http://skamansam.github.io/questlists. The code is redeployed when I finish any feature or want to test something, so it may change a lot and may break down often. I will do my best not to disturb any data that is already there, but be warned, your data may be a casualty of development!

Once everything is stable, it will become a REAL application, and all the notices about the demo will be removed.

Roadmap

Questlists is originally intended for game quests, so will have the following ideas implemented first:

  1. Your progress in quests.
  2. Items collected
  3. Overall progress in the game
  4. Locations reached
  5. Information about any other object in the game

I am sure you can generalize these ideas to fit any circumstance, so i will eventually create a few demos of lists for everyday use, such as a shopping list and various TODO lists.

Contributing

To keep things simple, I am only using GitHub and associated tools that anyone can use. I am even deploying this app to GitHub pages. For ticket management, I am using ZenHub, so you can use it too, if you want. All tickets will be managed through ZenHub, but you can create Issues in GitHub if you want, as well.

GitHub

If you would like to help with the development of this project, follow these instructions:

TL;DR - Fork repo and create a new branch for each issue, then create a new pull request. I won't be too 
harsh on the rest.
  1. fork this repo (or ask to join the BizziQuest team!)
  2. See if there is an issue currently in GitHub that addresses your feature, bugfix, etc. If not, create one!
  3. create a new branch in your forked repo, including the ticket number in the branch name, like 4-my-new-feature or my-new-feature_issue-4 or my_new_feature-issue_4. You get the idea.
  4. hack away!
  5. When committing your changes, please make sure you include the ticket number in the description, surrounded b y brackets. Something like make sure we use the correct ES2016 syntax for foo-bar elements. [46]. The commit message should read like a command, not a summary of what you did. (This is a hard one to follow, as you can tell from my commit messages, but it really does help new-comers get an understanding of what's going on.)
  6. Make sure ALL tests run successfully by running yarn check. This is to ensure you do not bug the application. Automated tests run for every PR and merge, and any code will not be merged without passing tests and linter checks.
  7. Create a new pull request against the develop branch once you are happy with your code
  8. Wait for the team to review and merge the changes. Merges cannot happen without review.

App Setup

We are using node version 10.x, due to compatibility with the firebase libraries. You should be using it as well. You can install nvm to manage local versions of node.

nvm use
npm install -g yarn
yarn
yarn serve

Running Questlists for Development

Just run yarn dev or yarn serve from the repo's directory. Running the dev command will start a local firebase emulator for you to connect for testing and local development.

Deploying Questlists

You can set up your own firebase instance at https://firebase.google.com. From there, you can configure firebaseConfig in main.js with your project's name. You need to have the following environment variables for deploying to your firebase instance. You can put these in a .env file, or copy the .env.example file.

VITE_APP_FIREBASE_API_KEY
VITE_APP_FIREBASE_AUTH_DOMAIN
VITE_APP_FIREBASE_DATABASE_URL
VITE_APP_FIREBASE_STORAGE_BUCKET
VITE_APP_FIREBASE_MESSAGING_SENDER_ID
VITE_APP_FIREBASE_APP_ID

Code Style Guide

Having a style guide really helps code readability and lessens cognitive overhead when developing software. I am using the Airbnb rules for eslint, with a few differences:

  1. line length is 120 characters. the 80 char limit has not been applicable for more than 20 years.
  2. You ARE allowed to use console.[error, info, warn] in production code. The team will be looking at these to determine whether they are used correctly and are necessary. You are not allowed to just console.log, as that usually means you are not thinking about why you need to print to the browser console.

NOTE: eslint is run as part of the testing for each PR so PRs will not be merged that don't pass the tests and linter. If you want to run the linter yourself, you can run yarn check.

Special Thanks

I want to convey a special thanks to Pimp Trizkit, for the use of his Pimped Javascript, which is covered under the GPL.