The NikNak App is the default UI for the NikNak Social Media Network.
- Node.js (v16 or later recommended)
- Yarn
- Xcode Command Line Tools (for iOS simulator)
- Expo CLI (if applicable)
-
Clone the Repository:
git clone https://github.com/TheNikNakCollective/NikNakApp.git cd NikNakApp
-
Install Dependencies: Run the following command to install all required dependencies:
yarn install
First open up an iOS Simulator
To open the iOS simulator and prepare for app installation:
yarn install:simulator
Once the simulator is open, start the app:
yarn start
This will initialize the development server and allow you to preview the app in the iOS simulator.
Here are the available scripts for common development tasks:
Command | Description |
---|---|
yarn install |
Installs all project dependencies. |
yarn install:simulator |
Opens the iOS simulator and prepares the environment for app installation. |
yarn start |
Starts the app and launches it in the simulator or Expo Go. |
-
Simulator Not Booted: Ensure the simulator is running before executing
yarn start
. Useyarn install:simulator
to open the simulator. -
Dependency Issues: If you encounter dependency conflicts, try clearing the cache and reinstalling:
yarn cache clean yarn install
- Use the React Native Developer Menu (Cmd+D in iOS simulator) for debugging tools like live reload and performance profiling.
We welcome contributions! To contribute:
- Fork the repository.
- Create a new feature branch:
git checkout -b feature-name
- Commit your changes:
git commit -m "Add feature-name"
- Push your changes:
git push origin feature-name
- Open a pull request.
This project is licensed under the MIT License.