Skip to content

Latest commit

 

History

History
122 lines (77 loc) · 4.02 KB

CONTRIBUTING.md

File metadata and controls

122 lines (77 loc) · 4.02 KB

Contributing

Thank you for considering to participate in the development of this application! Please read this guide then check Issues marked with the help-wanted tag.

What is this application?

The purpose of this app is to make it easer to copy an image from the screen to a physical paper:

  • select an image
  • align (zoom, rotate, pan) as you wish
  • lock the image
  • put a paper over the screen, grab a pencil and start tracing

Check out the Play Store page of the app and install it on your Android device to get familiar with it.

Prerequisites

If you know how Expo works, you are good to go, otherwise follow these steps:

  1. Install the official Expo App on your Android Device. This is required to run your version of the App on your mobile during development.

  2. Install Node.js on your development environment. This is required to get the required dependencies and run a development version that you can access from your Android Device.

  3. Install expo-cli

    npm install -g expo-cli

  4. Install a recent NPM:

    npm install -g npm

An alternative to installing Node.js locally (steps 2-4) is to use the provided Dockerfile to create a builder image for the application. In this case install Docker instead of Node.js and the NPM dependencies.

Step 1: Fork and clone the repo

Fork this repository then clone your fork.

git clone https://github.com/YOUR-USERNAME/tracing-paper-sketching.git

Step 2: Run the development server

Navigate to the project directory then use NPM to download the dependencies of the project:

cd tracing-paper-sketching
npm install

Then, start the development server:

npm start

When it's up and running it will display a QR code. You may have to wait a minute while your project bundles and loads for the first time.

Alternative using Docker

If you don't have Node.js locally, you can use Docker to build and run the project.

cd tracing-paper-sketching
./build.sh

This command creates the builder image and runs the NPM commands required to start the development server.

Step 3: Launch the app on your Android Device

Start the Expo Go App on your Android Device and scan the QR code. It will download and run the application.

Make sure that your smartphone and the development server are on the same network!

Step 4: Implement your changes

Please use the following guidelines:

  • Try the changes on your device.
  • Follow the same coding style as the code that you are modifying.
  • If necessary, update the documentation for the change you are making.
  • Write descriptive commit messages and add each logical change to a separate commit to make code review easier.

Useful links

The project relies on React Native and Expo. There are plenty of resources about this framework on the internet, but here are some useful links to get started.

Step 5: Submit changes

Push your changes and submit a Pull Request. Now it's my turn to review your PR and get in touch with you. :)