/lamboard

Lambdorks messageboard group project

Primary LanguageJavaScriptMIT LicenseMIT

lamboard

A message board built with a ReactJS foundation.

Getting Started

Prerequisites

  • Install yarn or npm. These are needed to install dependencies and run the local server.

Installing a developer environment

  1. Fork lamboard and clone to your local machine.
  2. From your console, cd into /server and type npm install or yarn install to install the server dependencies.
  3. Type yarn start or npm run-script start to run the included script nodemon server.js from package.json.
  4. CD into /reactapp.
  5. Type yarn install or npm install to install ReactJS dependencies.
  6. Type yarn start or npm start to run the developer client.

Built With

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.

Feature Contributions

  1. Visit the Trello board that you are interested in working on. Currently we have a Front End and Back End board.
  2. Pick a card from the To Do list that you would be interested in working on. Add yourself to that card and move it to the In Progress column.
  3. Create a feature branch on the develop branch if a feature branch does not exist for your contribution. Attach this branch to the card using the GitHub power-up.
  4. You will be working exclusively on the new branch created. You may invite others to contribute.
  5. If you are modifying a file from another branch during your development, please collaborate with the other developer that would be working on that feature.
  6. Please do not forget to test your feature before submitting the pull request.
  7. Once you are ready to request a pull, move your Trello card to the Pull requested column. Attach this pull request to the card using the GitHub power-up.
  8. Other contributors will test and review your submission. Open discussion is encouraged during the pull request.
  9. If the feature gets at least two approving reviews, the pull request will be merged; otherwise review the discussion, fix code, and commit your changes.
  10. Move the Trello card out of the Pull requested column. If you're ready to work on another feature related to the card, move it back to In Progress. If you're done working on the card but there are still more features to work on, move it back to To Do. If all related tasks have been completed and merged to the develop branch, move the card to Completed.
  • branch name format: feature/description, bugfix/description
  • examples: feature/registration-actions, bugfix/fix-infite-loop

Authors

  • Max Kajiwara - Initial work - maxkajiwara
  • Tim Hoang - Front end prototyping - timh1203
  • Michael Agard - Front end developer - michaelagard
  • Jordan Marsaw - Front end developer - blokboy
  • Eva Li - Back end developer - eeevvaaa
  • Clint Kunz - Back end developer | Authentication - clintKunz