Skip to content

Commit

Permalink
Readme Added.
Browse files Browse the repository at this point in the history
  • Loading branch information
smdthiranjaya committed Apr 5, 2024
1 parent af6eb39 commit 8e2a875
Showing 1 changed file with 26 additions and 43 deletions.
69 changes: 26 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,53 @@
# Getting Started with Create React App
## Student ID : COBSCCOMP4Y222P-033

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# Geo-360

## Available Scripts
Geo-360 is a React-based application designed to provide users with interactive geographical data visualization. Utilizing React with Leaflet for mapping, and a set of testing libraries for robust development, Geo-360 aims to deliver a seamless user experience in exploring geospatial information.

In the project directory, you can run:
## Getting Started

### `npm start`
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
### Prerequisites

The page will reload when you make changes.\
You may also see any lint errors in the console.
Before you start, ensure you have Node.js and npm installed on your machine. This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

### `npm test`
### Installation

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
First, clone the repository to your local machine:

### `npm run build`
git clone https://github.com/smdthiranjaya/Geo-360.git
cd geo-360

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
---

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
Install the necessary packages:

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
npm install

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**
---

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
### Running the App

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
To run the app in the development mode, use:

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
npm start

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
---

To learn React, check out the [React documentation](https://reactjs.org/).
Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

### Code Splitting
### Building for Production

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
To build the app for production to the build folder, run:

### Analyzing the Bundle Size
npm run build

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App
---

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Proxy Configuration

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
Requests are proxied to the backend server specified in the package.json under the proxy field. Ensure this is set to your backend service URL for development purposes.

0 comments on commit 8e2a875

Please sign in to comment.