Welcome to the AR Routing UI project! This project is a React-based user interface that allows the user to manage his/her Routes and Steps, while communicates relevant data to the larger AR project. It is designed to work alongside the AR project, which is being collaboratively developed by multiple teams, including us.
To run the project locally, follow these steps:
- Install Dependencies: If the project dependencies are not yet installed, navigate to the project directory in your Command Prompt or terminal and run:
$ npm install --no-save - Start the Project: Run the following command to start the project:
This will launch the project in your default web browser.
$ npm start
-
Install Node.js: If you don't have Node.js installed, you can download it from the official Node.js website.
-
Clone the Repository: Use the following command to clone the repository to your local computer:
$ git clone https://github.com/NadavBitran/AR-Routing-UI.git -
Install Dependencies: Navigate to the project directory in your Command Prompt or terminal and install the required packages:
$ npm install --no-save -
Create a New Branch: Before making changes, create a new branch for your work and switch to it:
$ git branch <new-branch-name> $ git checkout <new-branch-name>It can also be done with one line of command, like this:
$ git checkout -b <new-branch-name> -
Make Changes and Commit: Make the necessary changes to the code and use
git committo commit your work. -
Push Changes: Push your changes to the corresponding branch in the GitHub repository:
$ git push origin <branch-name> -
Create a Pull Request: When you're ready to merge your changes into the main project, create a pull request from your feature branch to the master branch. Describe the changes and purpose of the pull request clearly.