Skip to content

building.md

Latest commit

 

History

History
163 lines (107 loc) · 4 KB

building.md

File metadata and controls

163 lines (107 loc) · 4 KB
Raw

Building Clerotri

Required tools

The following steps assume you're using a terminal.

If you want to build Clerotri for web, you'll need:

If you want to build Clerotri for Android, you'll also need:

If you want to run/work on the analytics server, you'll need:

Steps

Clone the repository, then open the project folder:

git clone https://github.com/upryzing/clerotri
cd clerotri

Clerotri itself

Once you've opened the folder, run the following:

# install the dependencies...
yarn install

# ...then copy the font files into the native folder:
npx react-native-asset

Web

To run the development version of Clerotri for web, run:

yarn web

To build an optimised release version, run:

yarn web-release

Android

To run the development version of Clerotri for Android, run:

# build and install the native app...
yarn android

# ...then run Metro (the JS dev server):
yarn start

To build an optimised release version, run:

yarn android-release

Tip

You can run the JS bundling step separately from the actual app compilation/bundling step - for example, if you only need to rebuild the native code - by running yarn android-release:bundle and yarn android-release:apk respectively. Make sure you've built the JS bundle first, or the app won't run!

CLI commands

Command Description
yarn start Starts Metro (the JS dev server).
yarn web Runs the web app.
yarn android Runs the Android app.
yarn ios Runs the iOS app (broken, requires a Mac).
yarn format Formats the code using Prettier.
yarn lint Checks the code syntax using ESLint.
yarn test Runs the tests in the __tests__ folder with Vitest.

For more information, see a list of react-native's commands here. You can access them by running yarn react-native.

Note that the app uses rnx-bundle, which has extra features (and will produce a smaller bundle) compared to the default bundle command.

Analytics/badges server

Before running the server, you'll need to set up the database.

Connect to Postgres:

sudo -u postgres psql

Once you've connected to Postgres, create a user and a database for the analytics server:

-- RUN THESE INDIVIDUALLY!

-- create the user:
CREATE USER clerotri WITH PASSWORD 'flower31!';

-- create the database:
CREATE DATABASE clerotri_analytics;

-- grrant all privileges on the database to the user:
GRANT ALL PRIVILEGES ON DATABASE clerotri_analytics TO clerotri;

-- switch to the database:
\c clerotri_analytics

-- grant all privileges on the public schema too:
GRANT all ON SCHEMA public TO clerotri;

-- once you're done, exit Postgres:
\q

Enter the analytics server's folder:

cd external/analytics-server

Copy the .env.example file and fill it out as needed:

# copy the file...
cp .env.example .env

# ...then edit it (feel free to use any text editor here):
nano .env

Once you've filled out the .env file, install the dependencies:

deno install

If you're working on the server, run the following:

deno task dev

If you're not working on the server, run the following:

deno run --allow-env --allow-net --allow-read main.ts