Skip to content

Home

Jump to bottom
Shaun Vos edited this page Aug 8, 2022 · 10 revisions

LibreSchemas Client Wiki

The LibreSchemas project is a collection of Free and Open Source Software (FOSS), under various Copyleft licenses, that are designed to help those who identify as Neurodivergent. Libre means being “free, having liberty, at liberty” in Spanish and French. The mission of the LibreSchemas project is to create and make FOSS that the Neurodiverse community finds helpful as well as making it accessible for the community to new learn skills and contribute for the benefit of all Neurodiverse people. More information about LibreSchemas can be found at LibreSchemas.org.

Getting started with LibreSchemas Client using React Native Expo

  1. You need to download and install a copy of Node.JS on MacOS or Windows. We would recommend you install the LTS (Long Term Support) version.
  2. We recommend you download and install GitHub Desktop to checkout this repository. Read the GitHub Desktop Documentation. You could also download a Zip of this repository.
  3. You need to open a Command Window in Windows or Terminal for Mac. For Windows: Press Windows+R to open “Run” box. Type “cmd” and then click “OK” to open a regular Command Prompt. Mac: Open Finder, Go to Application, Utilities and Click on Terminals.
  4. You will need to become familiar with using the Command line interface. You need to go to the directory where libreschemas-client is installed (Git checkout) or unzipped. This involves typing cd YourDirName etc..
  5. The first command you need to run in the libreschemas-client directory is: npm install --legacy-peer-deps This installs all the packages listed in the package.json file into node_modules (We are using Node.JS). All these packages come from NPM.
  6. On your Android device or IOS (iPhone or iPad) you need to download the Expo Client from Google Play or the Apple App Store. Download: Expo Client on Google Play or Expo Client on App Store.
  7. Back to your computer, you need to run in the libreschemas-client directory: expo start Assuming this works you should have the client version running on your computer ready to be picked up by an Expo Client.
  8. Open the Expo client on your device (using the same WiFi). Expo should show Libreschemas from your computer running. Just click to launch and the App should run.
  9. LibreSchemas Client by default connects to our LibreSchemas Server hosted on api.libreschemas.org. You'll want to run your own LibreSchemas Server on your computer and edit the .env file to set API_URL to your localhost:port.

Encountering errors or functionality not working as expected

You will sometimes have to debug your app to find out why is it not working. The React Native Documentation, Expo Documentation, React Native Paper and React Navigation are helpful in learning and fixing most issues. You will have to be careful not to confuse bugs with LibreSchemas Server as LibreSchemas Server serves the Schemas to LibreSchemas Client.

Googling error messages can also show posts from helpful sites like Stackoverflow where others encounter similar problems to you. It can sometimes be trial and error but this is how you grow confidence and build experience. Taking regular breaks can be beneficial as well.

Volunteers needed

LibreSchemas is maintained by volunteers and requires more volunteers to maintain this repository. If you are interested in learning the skills above or are already proficient then please read Contributing and Contact Us to get involved.

LibreSchemas Client is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. LibreSchemas Client is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with LibreSchemas Client. If not, see https://www.gnu.org/licenses.

Clone this wiki locally