MapScout - Resource Map Maker
Learn more about MapScout here: https://www.stephaniefhe.com/mapscout
Build Instructions
-
Clone the repository
-
Run
yarn
(this is the yarn equivalent to npm install) -
Run
yarn run secrets
, enter in your super secret password when prompted
NOTE: If you are using the Windows command prompt, you will need to manually enter in yarn run secrets:login
and yarn run secrets:sync
- Now you can run
yarn start
ornpm start
whenever you want to run the app
Run With Docker
- Install Docker
- Obtain the Bitwarden password from your EM. Create a
bitwarden.env
file and fill it in with the following contents:This only needs to be done on your first run. After that, you should delete the file from your repository to avoid pushing it to Github.BW_PASSWORD=<your bitwarden password>
- Start the application with Docker Compose:
docker compose up
If you make any changes to the packages, you may need to rebuild the images. To do this, append --build to the above docker compose up command.
The Dockerized application will have live-reloading of changes made on the host machine.
Note: On linux-based operating systems, if you come across an entrypoint permission error (i.e. process: exec: "./entrypoint.sh": permission denied: unknown
), run chmod +x ./entrypoint.sh
to make the shell file an executable.
Windows Users: If you come across this error exec ./entrypoint.sh: no such file or directory
when running the docker compose command, please follow this Stackoverflow thread to fix it.
Gitflow
The master/main
branch automatically deploys to production, so all code should first go through the develop
branch first. Mapscout only accepts code that has been approved from a Pull Request. In order to make changes to the code, we recommend the following steps:
-
Create a new branch from develop (e.i.
feature/coolLoginScreen
) -
Create a pull request
-
Wait for approval from another developer
NOTE: You can create a new branch in command line with git checkout -b myBranchName
. To check what branch you are on, you can run git branch
. If you don't see a branch, try git fetch origin
.