woeip
woeip copied to clipboard
openoakland
Provide alternative to Docker for running local environment
Description
There is currently a known, unresolved bug running Docker on some Mac environments. This makes running WOAQ on a local environment a blocker for some developers.
Requested solution
- [ ] Provide an alternative to Docker for developing WOAQ locally.
- [ ] Developer can install the app on local Mac or PC environment
- [ ] Developer can make and review code/schema changes to database locally
- [ ] Developer can make and review code changes to API locally
- [x] Developer can make and review code changes to Create React app locally
- [ ] Document alternative processes in
ReadMe.md. - [ ] Remove Docker setup altogether for the reasons mentioned in the comments.
As much as it's meant to be an avenue for a "one-step setup", Docker also tends to be a barrier for entry to the project.
If I'm not mistaken, we're also removing it from our deploy process- rendering it meaningless from that perspective, as well.
Next, maintaining Docker files is tough. There is a lot of configuration and it must account for all the environments where it's used. If we are planning on creating an alternative, I would rather stop maintaining the Docker setup entirely.
Finally, Docker is starting to push more of its features behind paywalls. Might as well get out now.
Instructions I'm using to update front-end content (may or may not be helpful for documentation; this is really noob-centric; assumes you've already copied the repo locally):
Create and check out new branch based on an existing branch:
-
git status -
git checkout {existing-branch} -
git pull origin develop -
git checkout -b {new-branch-name}
Navigate to front-end directory:
-
cd {directory path} - Open text editor
-
package.jsonfile contains npm commands under "scripts"
Run front-end via command line:
-
npm installinstalls all needed libraries -
npm run start(should open in web browser)
In text editor:
- Make desired changes to files in
/srcfolder
Stage, commit and push changes:
-
git add .(don't forget that period!) -
git commit -m "{message text}" -
git push origin {new-branch-name}
Open PR in WOEIP repo:
- Request review from team member(s)
Prior to the npm start should be this instruction:
npm install to get all the required libraries
and there are many deprecated libraries here...
and there are many deprecated libraries here...
@mnorelli please open an issue with a list of deprecated libraries
and there are many deprecated libraries here...
@mnorelli please open an issue with a list of deprecated libraries
Done, as https://github.com/openoakland/woeip/issues/383#issue-1067854875
Docker sets up an NGNX server and database, helps handle migrations for DB, each needs to be dealt with.