https://github.com/nadavbitran/ar-routing-ui

https://github.com/nadavbitran/ar-routing-ui

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/nadavbitran/ar-routing-ui
• Owner: NadavBitran
• Created: 2023-08-14T13:44:37.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-02T11:25:23.000Z (7 months ago)
• Last Synced: 2024-05-02T23:51:32.332Z (7 months ago)
• Language: JavaScript
• Size: 729 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# AR Routing UI

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](https://github.com/KapGames/AR-Team "Link to AR project"), which is being collaboratively developed by multiple teams, including us.

## Built So Far Using

[![](https://skillicons.dev/icons?i=html,css,javascript,react)](https://skillicons.dev)

## Running the Project

To run the project locally, follow these steps:

1. **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

	```

2. **Start the Project**: Run the following command to start the project:

	```

	$ npm start

	```

	This will launch the project in your default web browser.

## How to Contribute

1. **Install Node.js**: If you don't have Node.js installed, you can download it from the official [Node.js website](https://nodejs.org/en).

2. **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

	```

	

3. **Install Dependencies**: Navigate to the project directory in your Command Prompt or terminal and install the required packages:

	```

	$ npm install --no-save

	```

4. **Create a New Branch**: Before making changes, create a new branch for your work and switch to it:

	```

	$ git branch 

	$ git checkout 

	```

	It can also be done with one line of command, like this:

	```

	$ git checkout -b 

	```

5. **Make Changes and Commit**: Make the necessary changes to the code and use `git commit` to commit your work. 

6.  **Push Changes**: Push your changes to the corresponding branch in the GitHub repository:

	```

	$ git push origin 

	```

7. **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.