An all-encompassing end-of-life planning app.
-
Clone the repository
git clone https://github.com/GenerateNU/legacy.git cd legacy -
Install dependencies
cd client yarn install- If you get an error about
expo-clinot being installed, runyarn global add expo-cliand then runyarn installagain.
cd server go get ./...- If this doesnt work, try running
go mod tidyand thengo get ./...again or delete the go.mod and go.sum files and then rungo mod init serverandgo mod tidyagain.
- If you get an error about
-
Install requirements.txt
pip install -r requirements.txt pre-commit install
- Using a virtual environment is not necessary, but recommended.
-
Create client build
cd client eas login eas build:configure # ios eas build -p ios --profile development # android eas build -p android --profile development
-
Download the build and drag into simulator
-
Start the client
cd client npx expo start --dev-client- You can then open the app in the Expo app in the simulator.
-
Start Postgres
- MacOS
brew services start postgresql@[version]
- Windows
pg_ctl -D /usr/local/var/postgres start
-
Start the server
cd server task run- If this returns an error like 'air does not exist' try running
go install github.com/cosmtrek/air@latest
-
Clone the repository
git clone <repository-url>
-
Create a new branch
git checkout -b feature/<branch-name>
-
Make changes and commit changes:
-
Commit changes
git add . cz commit- You are not required to use commitizen, but it is recommended. If you choose not to use commitizen, please follow the commit message format described here.
-
Bump version
cz bump
-
We use pre-commits that allow us to format code before committing. This ensures that all code is formatted the same way. If your code gets formatted you will need to run
git add .again before committing to add the formatted code to the commit. You can also runtask formatto format all code. -
More information on commit messages can be found here.
-
-
Push changes to GitHub
git push origin feature/<branch-name>
-
Create a pull request
- Go to the repository on GitHub
- Click on the
Pull requeststab - Click on the
New pull requestbutton - Select the
basebranch asmain - Select the
comparebranch asfeature/<branch-name> - Click on the
Create pull requestbutton
Use commitizen to create commit messages.
cz commit
cz bump- Commit messages should be in the present tense.
- Keep them short and concise. If necessary, add a longer description in the body of the commit.
- Use the following format for commit messages:
<type>: <subject> <BLANK LINE> <body> - The
<type>can be one of the following:- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
- Ensure your pull request has a clear title and a summary of the changes made.
- Describe the problem you're solving or the feature you're adding.
- Mention any related issues or dependencies.
- Ensure your changes don't break any existing functionality, add tests if necessary.
- Request reviews from fellow developers or team members.