Installation

We use a yarn workspace: thus, it is possible to install and launch the project directly from the root folder.

Requirements

NodeJS 18+
Yarn 4.0+
PostgreSQL 14 and PostGIS

To use the backend locally and not the hosted version based on the develop branch:

Ngrok

1. Create the .env file for the app/ application

Following the schema of the .env.example file, complete the different variables.
EXPO_PUBLIC_API_URL corresponds to the URL of the API.

Note: To use the hosted API (corresponding to the code of the develop branch) and not the local backend, just use this address:

Dev environment (develop branch):

EXPO_PUBLIC_API_URL=http://165.227.142.139

Prod environment (main branch):

EXPO_PUBLIC_API_URL=http://165.232.112.4

Note2: To use the local backend, you must use the ngrok tool, following the instructions in the wiki after installing and setting up the backend.

2. Install the packages:

yarn install

3. (optional, to start the local backend) Create the .env file for the backend/

Following the schema of the .env.example file, complete the different variables.

DATABASE_URL corresponds to the URL of the postgresql database.
JWT_SECRET corresponds to the secret key that will be used to generate JWT tokens.
PORT corresponds to the port on which the server will be launched. (8081 by default)
S3_ENDPOINT is the endpoint of the S3 API
S3_BUCKET is the name of the S3 bucket
S3_ACCESS_KEY_ID is the public S3 key
S3_SECRET_ACCESS_KEY is the private S3 key

4. (optional, to start the local backend) Creation of tables and filling of the database

yarn backend:setup

5. Launch the project

Launch the backend/application

yarn dev

Launch only the mobile application

yarn native

Launch only the backend

yarn backend

6. App default logins

Default user account

admin@linkink.fr
password

Default tattoo artist account

tattoo@linkink.fr
password

App utilization

App logout

Log out as user

Compte > Se déconnecter

Log out as tatoo artist

Compte > edit icon > Se déconnecter

Corentints/linkink