Skip to main content

Clone or Fork the Project

This guide provides detailed instructions on how to clone or fork the ReentryGuide GR project for development.

Overview​

Cloning and forking the repository allows you to create a local copy of the "ReentryGuide GR" project, enabling you to contribute to its development, test new features, or customize it for your own needs.

Prerequisites​

Ensure you have the following installed:

  • Node.js
  • npm or Yarn
  • React Native environment setup

Forking the Repository​

Forking the repository creates a personal copy of the project under your GitHub account. This is useful if you plan to contribute to the project or use it as a base for your own development.

  1. Navigate to the GitHub Repository:

  2. Fork the Repository:

    • Click the 'Fork' button at the top right corner of the page to create a copy of the repository under your own GitHub account.

  3. Clone Your Fork:

    • Clone the forked repository to your local machine using the following command: 
      git clone [email protected]:your-username/client.git
      Replace your-username with your GitHub username.

Cloning the Repository​

Cloning the repository is useful if you simply want a local copy to work on without creating a fork on GitHub.

  1. Navigate to the GitHub Repository:

  2. Clone the Repository:

    • Clone the repository to your local machine using the following command: 
      git clone [email protected]:ReentryGuide-GR/client.git

  3. Navigate to the Project Directory:

    • Change into the project directory: 
      cd client

Installing Dependencies​

Once you have cloned or forked the repository, install the necessary dependencies using either npm or Yarn:

Using npm:

npm install

Using Yarn:

yarn install

Running the App​

npx expo start