diff --git a/README.md b/README.md index b9114af..d9a2d38 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,15 @@ -## TODO for the Techies -Please **fill out the following information below**, as soon as possible. It is **required** to have this file completely filled out and up to date at the end of the project phase. -You can of course use this file to manage your project, e.g. as a place to keep your todos and to plan your features. Also, feel free to edit this readme in any kind of way you like, but the required base layout and information should be consistent throughout all techie projects. - -**Hint:** The following file is written in `markdown` which is a language to format text with simple characters. If you are unsure on how to use markdown then have a look at [this guide](https://www.markdownguide.org/basic-syntax/) - -By the end you should have filled out the following: -1. **Project Title:** The title of the project, including a description which states the motivation/problem of the project and the developed solution. -2. **How to Setup and Run:** The respective commands to install and run the project -3. **Examples:** A brief overview on how to use the main functionalities of your project (does not have to be code) -4. **Roadmap:** The general outline of what you want to do in what order. Please keep this up to date, so that we can follow what you are and will be doing. -5. **Authors:** Please add all of you and link your respective GitHub profile and other information if you want to. This part if completely up to you. -6. If you are done filling out the information below, please **delete this TODO Section** to keep your project readme clean for other people to get to know more about your project. - # Bottom-up.city Create a web app that helps people find bike sharing and car sharing services, additionally co-working spaces or other data which might be interesting for people to to reduce mobility. Idea: People don't want to move between different areas of a city, they search for solution nearby. ## How to Setup and Run In order to setup the project, please proceed as follows: +Navigate to the React App with Leaflet folder using terminal. Then run the following command to install all the dependencies: ```bash - npm install my-project\bottom-up-city\React App with Leaflet -``` - -After successful installation use the following command to run the project: - -```bash - npm run + npm install ``` - -Then run npm start to start a local server which can show the application in the browser +To run the project, execute the following command. It will start a local development server which can show the application in the browser ```bash npm start