From d9b87a9be63f18d0ee1cabaf5210f63289495297 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Wahlberg?= Date: Mon, 16 Nov 2020 18:10:31 +0100 Subject: [PATCH] Add README.md --- README.md | 79 ++++++++++--------------------------------------------- 1 file changed, 14 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index 0c83cde..e732854 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,19 @@ -# Getting Started with Create React App +# Hållbar Utveckling - Utmaning VT7 -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +Här finns kod för den prototyp som utvecklades av projektgrupp 3 i kursen ENM156 på Chalmers Tekniska Högskola. -## Available Scripts -In the project directory, you can run: +## Utvecklingsmiljö +### Förutsättningar +Se till att ha följande mjukvara installerad och fungerande innan nästkommande steg utförs: +* [NodeJS](https://nodejs.org/en/) +* [Git](https://git-scm.com/downloads) -### `npm start` +Om du använder terminalen för att köra kommandon kan du behöva lägga till sökvägarna bland dina miljövariabler (om sitter på Windows). -Runs the app in the development mode.\ -Open [http://localhost:3000](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. - -### `npm test` - -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. - -### `npm run build` - -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! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `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. - -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. - -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. - -## 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/). - -### Code Splitting - -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) - -### Analyzing the Bundle Size - -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) - -### 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) +### Första Gången +1. Klona repot genom valfritt Git-verktyg eller genom att köra kommandot +```git clone git@github.com:williameriksson126/hallbarUtvecklingVT7.git``` +i en terminal. +2. Navigera till roten av projektmappen/öppna projektet i din IDE och kör kommandot ```npm install``` via en terminal eller genom ett tillägg i din IDE (ex. VS Code har möjlighet att köra npm-scripts). +3. Verifiera att projektet fungerar som det ska genom att återgå till terminalen/tillägget och köra kommandot ```npm start```. \ No newline at end of file