[Track 2/8] Project Setup

[taki-tiler[bot]]

Step 1/5 - Create a git branch

• Create a branch called feature/setup

If you don't remember how to create a branch, check the references in the previous issues.

Note: From here, the issues will contain fewer tutorials and step-by-step guides. However, it doesn't mean you won't be able to ask. You can always ask anything to any Taqtiler. We are here to help 😉

Note 2: Be patient, this is the last setup before coding. 👍

[guiabqf]

Finish

[taki-tiler[bot]]

Step 2/5 - Create a simple Hello World

Estimated time: 3 hours

Follow a tutorial project to create a minimal "Hello World" application using the technology stack you were assigned. If you don't know on which tech stack you are, please ask your tutor before continuing. We use react for web projects and react-native for mobile apps, both using Typescript. Below there are instructions for creating an simple Hello World in the tech stack you were assigned. So pick up yours and read it carefully:

React

• They have a this awesome tutorial to begin developing
• You only have to run npx create-react-app your-project-name --template typescript on terminal
• Clean up some code to show only a simple "Hello World"

React-native

• Start with their tutorial to make sure you have everything you need. Use the React Native CLI Quickstart, so you can be closer to how a Taqtile project works.
• When you reach the code setup, use the command with Typescript template: npx react-native init YourProjectName --template react-native-template-typescript
• Clean up some code to show only a simple "Hello World"
• You can call it "done" after you're running it successfully on Android and iOS emulator (or device, if you prefer 🤓)

Note: For now on, some steps will have an estimated time to help you organizing your time better. If you do not finish the step in the estimated time don't worry! It's just an average time based on previous onboards. The main purpose of this estimated time is to indicate when you should ask for help in case you're stuck.

By the way, remember that if you're struggling with any topic, feel free asking any Taqtiler ;)

[guiabqf]

Finish

[taki-tiler[bot]]

Step 3/5 - Create a Pull Request

• Open a Pull Request of your feature/setup branch

If you don't remember how to open a Pull Request, check out the references in the previous issues. Your PR should have develop branch as base, to be merged into later.

This pull request will be reviewed by your Taqtile tutor and possibly by some other people. This process is called Code Review (CR). You can ask your tutor who will be revising your code.

Mark them on every Pull Request as reviewers. Check here an example of Code Review. You'll possibly have some changes requested/suggested in order to merge your new branch on develop.

[guiabqf]

Finish

[taki-tiler[bot]]

Step 4/5 - Update README.md

Estimated time: 20 minutes

Do you remember we created the README.md of this project before? Now that you have a project created on your technology stack, it's time to update it with some piece of information.

Since the feature/setup is (probably) still being reviewed, we need to create a new branch for this current step's task. Let's call this new branch docs/update-readme. Here's what you'll need to do:

• Go to develop branch: git checkout develop
• Open a new branch called docs/update-readme
• Update the Environment and tools section with some data about... well... your machine environment and the tools you're using. Things like the Node version, the Android Studio/Xcode version, the programming language any other relevant data for a developer to getting started in your project.
• The Steps to run and debug section is usually filled with information about how to run your project, such as what commands should the developer use or which configurations should he/she turn on/off before executing your project.

After that, open a pull request with these README.md changes.

TIP: an excellent README is that one document that is sufficient for any developer to be able run and contribute to your project.

[guiabqf]

Finish

[taki-tiler[bot]]

Step 5/5 - Rebasing your branch

Here in Taqtile, before merging our revised (and approved) branches, we rebase this branch into the one we are attempting to merge. In this case, you'll rebase docs/update-readme or feature/setup to develop, depending on which one was reviewed and approved first.

Too confusing? Here are some good links you can read about rebase:

• Git Rebasing
• What is git rebase?
• Bonus: Merging vs. Rebasing

Note: Remember that if you are stuck in any of these topics, feel free to ask any Taqtiler. We are here to help 😉

The ideal setup we are trying to achieve with the rebases are something like this:

[guiabqf]

Finish

[taki-tiler[bot]]

Click here for your next track