Skip to content

Commit

Permalink
Merge pull request #25 from M2JT/addingEnvPropertiesFile
Browse files Browse the repository at this point in the history
adding to env file and README
  • Loading branch information
hackrmann authored Dec 21, 2023
2 parents 2c6e873 + b34310e commit 953f68e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,13 @@ We all know how annoying it can be when our devices run out of battery, especial
### In the Front-end Directory
#### Set Up and Run the Front-end
1. In VS Code, Run `npm install` to install all dependencies listed in `package.json`.
2. Create a `.env` file and save it in the root directory. To ensure this file is configured with the correct environmental variables, please contact our developers for more information, as those data are sensitive and not allowed to be publicly shared on GitHub.
2. Please follow the instructions in .env file in root folder to ensure the project is properly configured with the correct environmental variables. In case of issues, please contact our developers for more information, these data are sensitive and not allowed to be publicly shared on GitHub.
3. Run `npm start` to start the front-end.
4. Open [http://localhost:3000](http://localhost:3000) to view our app in your browser.

### Run the Tests
1. In IntelliJ, go to **src** -> **test** -> **java** -> **com.opensourcedev.backend**, and run `MainTest`
![unit tests](documentation/unit%20tests.png)
2. Alternatively, you can run `mvn test` in back-end's root directory using terminal.
![unit tests in terminal](documentation/unit%20tests%20terminal.png)
![unit tests in terminal](documentation/unit%20tests%20terminal.png)
3. You can also run postman tests for integration testing by importing and running the collections inside [LoginResgisterTests](postma%20tests/Login-register.postman_collection.json)
3 changes: 3 additions & 0 deletions front-end/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#add your google maps api key below for the map functionalities of the project to work
REACT_APP_API_KEY =
REACT_APP_SERVER_URL = http://localhost:8080
2 changes: 1 addition & 1 deletion front-end/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

# misc
.DS_Store
.env

.env.local
.env.development.local
.env.test.local
Expand Down

0 comments on commit 953f68e

Please sign in to comment.