Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

Latest commit

 

History

History
117 lines (95 loc) · 7.47 KB

README.md

File metadata and controls

117 lines (95 loc) · 7.47 KB
Raw

codex-frontend

The frontend for Codex, written in React with Material UI components.

Contributions

Found a bug? Submit a report here.

Developer contributions are very much appreciated. Refer to the contribution guide or reach out to us on the Wild Me discord.

Setup and Installation

To install a working codex-frontend dev environment, you'll need install the backend by following the instructions in the Houston.

Instructions assume that you are signed into your GitHub account, have admin access to your OS's terminal, and have Git, Docker, and docker-compose installed. Instructions are written for linux with limited support for other OSs.

  1. From your browser in the top right corner of the codex-frontend repo, click the Fork button. Confirm the be redirected to your own fork (check the url for your USERNAME in the namespace).
  2. In your terminal, enter the command git clone https://github.com/USERNAME/codex-frontend
  3. Once you have both houston and codex-frontend repos available, move to your codex-frontend repo with cd codex-frontend
  4. Add a reference to the original codex-frontend repo to denote it as an upstream repo.
git remote add upstream https://github.com/WildMeOrg/codex-frontend
git fetch upstream
  1. Set up (husky)[https://github.com/typicode/husky] so that the linter runs before you commit.
  2. Run the command npm install husky -D
  3. npm run prepare
  4. In the houston project, edit the docker-compose.codex.yml file to redirect to your local copy of the dev-frontend code.
  5. In the file, find dev-frontend: and navigate to volumes:
  6. Delete the line - ../../_frontend:/code
  7. In its place, enter - LOCATION/codex-frontend:/code where LOCATION is the relative path to your local copy.
  8. Save your changes.
  9. Back in the terminal, cd to your local houston copy and run the following commands, noting that the docker-compose steps may take a long time to run the first time:
./scripts/codex/activate.sh
./scripts/codex/build.frontend.sh
docker-compose pull
docker-compose build
docker-compose up -d
  1. In your browser, go to https://localhost:84. If you see a welcome screen with Codex Initialized, you're ready to get started!
  2. If you see a blank screen or a 502 nginx error, run docker-compose down to bring down the instance.
  3. Allocate more memory to Docker. * If you're on linux, enter the command sudo sysctl -w vm.max_map_count=262144. This will need to be done each time you restart your system. Instead, add vm.max_map_count = 262144 to your system file /etc/sysctl.conf * If you're leveraging Docker Desktop, go to Settings > Resources and adjust the Memory limit.
  4. Run docker-compose up again.

App Setup

  1. At http://localhost:84, work through the admin initial setup.
  2. Navigate to Set Settings > Custom Fields
  3. Add Species
  4. Add Regions

Development

Create Local Branch

  1. Verify you are on the main branch. The branch you have checked out will be used as the base for your new branch, so you typically want to start from main. git checkout main
  2. Create your feature branch (FEATUREBRANCHNAME). It can be helpful to include the issue number (ISSUENUMBER) you are working to address. git branch ISSUENUMBER-FEATUREBRANCHNAME
  3. Change to your feature branch so your changes are grouped together. git checkout ISSUENUMBER-FEATUREBRANCHNAME
  4. Update your branch (this is not needed if you just created a new branch, but is a good habit to get into). git pull upstream

Git Commands

As you make the code changes necessary for the issue you're working on, you may find the following git commands useful.

  • git log: latest commits of current branch
  • git status: current staged and unstaged modifications
  • git diff --staged: the differences between the staging area and the last commit
  • git add <file name>: add files that have changes to staging in preparation for commit
  • git commit: commits the staged files, opens a text editor for you to write a commit log

Docker Commands

The following commands are helpful when developing in this manner:

  • docker-compose up -d: Run all containers in daemon mode, so you don't see all the logs running together.
  • docker-compose restart <image>: Restart a particular docker image (remember these are listed in docker-compose.yml).
  • docker-compose logs -f <image>: Show logs for a particular image.
  • docker-compose down: Stop all images.

Configuration and build

A build can be initiated with the command npm run build. You can specify the URL for Houston in /config/config.json or as a command line argument. Here are some examples:

npm run build -- --env=houston=https://houston.dyn.wildme.io
npm run build -- --env=houston=http://localhost:9999
npm run build -- --env=houston=relative // use relative file paths for API requests

Submit PR

Up to this point, all changes have been done to your local copy of codex-frontend. You need to push the new commits to a remote branch to start the PR process. Note: Now is the time to clean up your PR if you choose to squash commits. If you're looking for more information on these practices, see this pull request tutorial.

  1. Push to the remote version of your branch git push <remote> ISSUENUMBER-FEATUREBRANCHNAME If you want to push upstream directly, use git push origin ISSUENUMBER-FEATUREBRANCHNAME
  2. When prompted, provide your username and GitHub Personal Access Token. If you do not have a GitHub Personal Access Token, or do not have one with the correct permissions for your newly forked repository, you will need to create a Personal Access token.
  3. Check the fork's page on GitHub to verify that you see a new branch with your added commits. You should see a line saying "This branch is X commits ahead" and a Pull request link.
  4. Click the Pull request link to open a form that says "Able to merge". (If it says there are merge conflicts, go to the Wild Me Development Discord for help).
  5. Use an explicit title for the PR and provide details in the comment area. Details can include text, files, or images, and should provide details as to what was done and why design decisions were made.
  6. Click ** Create a pull request**.

Respond to Feedback

At this point, it's on us to get you feedback on your submission. Someone from the Wild ME team will review the project and provide any feedback that may be necessary. If changes are recommended, you'll need to checkout the branch you're working from, update the branch, and make these changes locally.

  1. git checkout ISSUENUMBER-FEATUREBRANCHNAME
  2. git pull upstream main
  3. Make required changes
  4. git add <filename> for all files impacted by changes
  5. git commit

Thanks

  • Thanks to Lokalise for providing translation management services.
  • Thanks to Flatfile for providing data import services.
  • Thanks to Emily Ke for developing the server status screen, page transitions, and more!
  • Thanks to Madeleine Webb for design assistance.
  • Thanks to Iris Shin for design assistance.