/dudoku

Primary LanguageTypeScriptMIT LicenseMIT

Dudoku = Duel + Sudoku

Netlify Status

Local Development

  1. Fork and clone repo.
  2. Run yarn to install all dependencies.
  3. Run npm i netlify-cli -g to install the netlify command line interface.
  4. Run netlify dev --functions=functions to start local dev environment.
    1. the --functions flag tells netlify where the serverless functions are located. e.g. the functions directory at the project root.

Branches

Contributing

We will use GitFlow. Instead of linking to a complicated article on what that is, just follow the steps below. (Look it up later)

If you don't already have the project locally, make sure to clone the repository using SSH.

We will have a master branch, and a develop branch, and <feature|bugfix>/<ticket-number>-<small-summary-of-ticket> branches.

Treat the develop branch like the master branch. So when working on a new feature/bugfix, follow these steps:

  1. Switch to develop.
> git checkout develop
  1. Pull the latest code from develop. git pull
> git pull
  1. Switch to a new feature or bugfix branch using the ticket # from the associated Trello card. e.g. to create a branch for a feature with ticket #123, do the following:
> git checkout -b feature/123-a-summary-of-the-work
  1. Make all commits on this newly created branch.
  • The following command stages all of your current working files to be committed:
> git add .
  • This next command commits your work. Make sure to put a descriptive commit description that finishes this sentence: This commit:
> git commit -m "adds a new commit"
  1. Push the new branch, and make a new pull request (PR) into develop on GitHub.
  • The first push on a new branch should give you more information on what command to run to actually push to GitHub
> git push
  1. Other devs will review your code and leave comments/suggestions.
  2. Push fixes to your code based on the comments/suggestions.
  3. Please do not resolve the comments on your own. (In the real world - on a good team - the person who made the comment will check up on the status of their comment). Meaning - if I left a comment to fix something, and you fix it, still don't resolve the comment yourself!
  4. After all of the reviewer's comments are dealt with, the reviewer will resolve all of his comments, and will leave an 'LGTM' comment. (Looks Good To Me)
  5. The person who opened the PR can/will merge his own pull request and then delete the branch.
  6. Since the new PR was merged into develop, your own develop branch will be out of date. Therefore, pull the latest develop code again, making sure to switch to develop first.
> git checkout develop
> git pull

Technologies Used

  1. Gatsby
  2. React
  3. Redux
  4. Redux Sagas
  5. TypeScript
  6. Tailwind CSS
  7. PostCSS (with Tailwind CSS)
  8. Netlify Functions (serverless lambda functions)