Furnishing Futures TTP App Project

Getting Started

Make sure your Powershell/VSCode terminal is cd-ed into the folder:

Open VSCode and press Ctrl + `. Select Bash or Powershell or
Open Powershell and run cd <FULL PROJECT DIRECTORY>

Install dependencies

$ yarn
# -- or --
$ yarn install

Start coding
Run App

# Installing Android App
$ yarn run android

# Running App
$ yarn start

Extra Commands

# ==================
# IOS (WORK IN PROGRESS)
# ==================

# Installing `iOS` dependencies
$ cd ios && pod update && pod install && cd -

# to open project in xcode
$ yarn run xcode

# to start `ios` emulator
$ yarn run ios

Miscellaneous

If you wish to install/remove dependencies in projects or packages, you can use command below

# Installing new packages
yarn add <DEPENDENCIES>

# Removing packages
yarn remove <DEPENDENCIES>

Technologies Used

Package Manager - yarn
Coding styles - TypeScript
UI styles - styled-components
UI Framework - React Native
Coding Practice - Eslint rules for (.ts, .tsx)

Folder Structure

To Be Added

Assets

Assets should be stored within the Assets folder (TBA)

// In react native project
import { Image } from "react-native";

const logo = require("../assets/static/dog.png");
<Image source={logo} />

Theme

This project sports

└── src
    └── theme
        ├── colors
        └── palette

To minimize excess typing, just modify the colors within colors, palatte under the theme folder. You can then access the value by importing the package. For example:

import { colors, palette } from "../../theme"; // This import will be fixed soon

colors.primary // primary color
palette.black // black color

Remember to practice using/creating reusable components

React Native

If you are currently running into issues please remember to refer to the React Native Official Documentation

Styled Component

Official Docs - https://styled-components.com/
Github - https://github.com/styled-components/styled-components

micheunderscore/ffttp