FastMart Template Documentation
1. Introduction
Project Title: FastMart Template
Version: 1.0.0
Author: Appfast.io
Date: August 2, 2024
Description: FastMart Template is a fully functional mobile app template built with React Native and Expo, designed for quick and easy customization. You can use it to quickly create your own mobile app with minimal effort for your existing WooCommerce website, compatible with any templates.
Below is a quick guide to run the project.
Please visit https://docs.appfast.io for detailed instructions
!! Especially to customize the UI you can use Appfast Studio at https://dash.appfast.io for more convenience, without having to custom code
2. Table of Contents
3. Getting Started
Prerequisites
-
Software Requirements:
- Node.js (version 20.x or later)
- npm (version 9.x or later) or yarn (version 1.20 or later)
-
Knowledge Requirements:
- Basic understanding of React Native
Installation
After purchasing FastMart app on CodeCanyon, download the source code package.
Extracting the zip file of source code, open it with Android Studio or Visual Studio Code.
Open iOS/Android simulator.
Install Dependencies:
# install package
yarn install
# setting & export expo Android & iOS
npx expo prebuild
Project supports running on all 3 platforms Web, Android & iOS
# for web:
yarn web
# for Android
yarn android
# for iOS
yarn ios
4. Configuration
Project Structure
The project structure is as follows:
├── assets
├── src
│ ├── app
│ │ ├── blocks
│ │ ├── components
│ │ ├── utils
│ ├── i18n
│ ├── types
│ ├── Loader.tsx
│ └── project.json
├── index.ts
├── package.json
└── readme.md
- assets: Contains images and other assets
- src/blocks: Contains block components. Each block has its own folder, for example,
src/blocks/Block1 - src/components: Contains reusable components
- src/utils: Contains utility functions
- src/i18n: Contains translations
- src/types: Contains interface/type definitions
- src/Loader.tsx: The root component
- project.json: Project configuration
- index.ts: Entry point of the app
- package.json: Project metadata and dependencies
Configuration Files
- src/project.json: All configuration settings for the app here.
WooCommerce Configuration
If you already had a WooCommerce website, you can get the WooCommerce API key and configure it in the src/project.json file.
If you don't have a WooCommerce website, you can use our Appfast cloud backend in the Appfast Studio.
5. Customization
There are 2 ways to customize the design of this app:
-
Customize via the drag&drop Appfast Studio tool.
You can create an account on Appfast Studio, then create an app with your Envato key.
You can customize your design, then export the JSON file, and replace it with
src/project.jsonin the source code of app. -
Customize directly on the source code of app via Android Studio or Visual Studio Code as below:
Modifying Components
To customize a component, locate it in the src/app directory. For example, to modify the Button component:
// src/app/components/Pressable.tsx
import React from "react";
import { TouchableOpacity, Text } from "react-native";
const Button = ({ title, onPress }) => (
<TouchableOpacity onPress={onPress} style={styles.button}>
<Text style={styles.text}>{title}</Text>
</TouchableOpacity>
);
const styles = {
button: {
backgroundColor: "#ff6347",
padding: 10,
borderRadius: 5,
},
text: {
color: "#fff",
fontSize: 16,
},
};
export default Button;
Adding New Features
To add a new component, create a new file in the src/app/components directory. For example, to add a Profile component:
// src/app/components/Profile.tsx
import React from "react";
import { View, Text } from "react-native";
const Profile = () => (
<View style={styles.container}>
<Text style={styles.text}>This is the Profile component.</Text>
</View>
);
const styles = {
container: {
flex: 1,
justifyContent: "center",
alignItems: "center",
},
text: {
fontSize: 18,
},
};
export default Profile;
6. Deployment
Android
-
Build APK:
expo build:android -
Install APK on Device:
- Transfer the APK file to your device and open it to install.
iOS
-
Build IPA:
expo build:ios -
Install IPA on Device:
- Use Xcode or TestFlight to install the IPA on your iOS device.
Web
-
Build Web App:
expo build:web -
Open Web App:
open http://localhost:8081
7. FAQs
-
How do I change the app name and icon?
- Modify the app.json file and update the name and icon properties.
-
How do I integrate third-party services (e.g., Firebase)?
- Follow the official documentation for integrating third-party services. Add necessary packages and configuration in App.js.
8. Support
For support, contact us at [support@appfast.io].
If any errors occur during use, please report them to us at https://github.com/appfast-io/docs
9. Changelog
- 1.0.0: Initial release.
