Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

100 lines (65 loc) · 2.94 KB
Raw

Important note: we've been improving our docs for v2. Please refer to our discord or to this discussion if you face any problems while setting up the project.

Thanks! ❤️

Contributing

Pre-requisites

  • Linux based distro or MacOS (we don't recommend Windows due to compatibility issues)
  • Node: 16.17.1 or higher.
  • Npm: 7.5.2 or higher.

Getting started

The master and next are stale branches, please do not use them.

Fork the project, then clone it. Make sure you're cloning v2 branch:

git clone --branch v2 git@github.com:[your-github-user]/animavita.git
cd animavita

Install dependencies:

$ pnpm install

In order to reflect the changes made in the shared packages to the mobile app, you must run:

$ pnpm shared:watch

Click here if you want to work only on the mobile app

Running the infra & backend with docker

We have a docker-compose file that sets up a mongodb database and the backend app for you. Just run:

$ docker-compose up -d

We're caching the node_modules folder to leverage cross-platform compatibility. So the first time the container is up, an anonymous volume gets created for the dependencies. With that said, whenever you change the shared packages or install a new dependency, you must rebuild the docker image telling docker to NOT use the existing volume from the previous container:

$ docker-compose up --build --force-recreate -V

Running without docker

Alternatively you can setup your own mongo database without docker. Then, from the backend app level, copy the env file:

$ cp apps/backend/.env.example apps/backend/.env

To use the geolocation service when running the mobile app on the web version, you need to have an API key from Opencage. You can obtain an API key for free by registering on their website, and there is no need to register a payment method for this. After obtaining the API key, add it to the OPENCAGE_KEY environment variable.

Then, run the app:

$ pnpm backend start

Running the mobile app

Then, run the app:

$ pnpm mobile start

Developing with staging backend

In this case, you don't need to worry about the backend part. We have a hosted staging environment you can use while developing locally. Keep in mind it might be unstable, so in case you face any problems follow the above steps to get the backend running locally as well.

To point the app to staging, create a .env file and set the ENV variable to staging.

cp .env.example .env

Then, run the app:

pnpm mobile start

Sending a pull request

PR description

  • Prefer small pull requests focused on one change.
  • Verify that typescript, eslint and all tests are passing.
  • Preview the documentation to make sure it looks good.
  • Follow the pull request template when opening a pull request.