*(Required)*For anyone who is contributing to this repo you will need to use git lfs(git large storage). It serves as an way to by pass the git restriction on 100MB file size upload to the repo.
git lfs make the uploaded file serve as a pointer to the actual content. filename -> actual content of file.
(Required) To install Redis Cache if the user of this repo is intended to start the spring boot application. To do so, please read the following instructions.
For windows: here
For mac: here
More explanation: here
- In this repo, do
git lfs install - In this repo, do
git lfs track file1 file2 ...for any files that is too large. Currently it is two the precinct geojsons inclient/public - Then do
git lfs migrate info --include = "file1, file2"ONLY if the commit failed otherwise skip this step - Verify that files are tracked by
git lfs, dogit-lfs ls-files, if you see files listed then you should be good to go. - Now you can use git as usual,
git lfswill handle the rest for us If there's any questions refer to medium article
To start the server, you will need to supply a bash script to load environment variables for application.properties file within Spring Boot.
The example file looks like below
set_env.sh
#!/bin/bash
# Set environment variables
export MONGO_USERNAME=_
export MONGO_PASSWORD=_
export MONGO_DB_NAME=_
It is required that this file is named set_env.sh
Make this file executable by doing chmod +x set_env.sh
Add the script on the same directory as mvnw file. If you place it anywhere else, please add the file into the .gitignore file in the root directory.
The command to run the script:
source set_env.sh
Start redis server
redis-server
Then in the same directory that the script was ran in run the following command to start the project:
./mvnw spring-boot:run
