A minimal, open source notes app built with React-Native & Expo.
Introduction • Prerequisite • How To Use • Contributing • License
- Beyojar is a simple notes taking application built for Android & IOS using React-Native & Expo
- The mobile workspace contains all the code related to the mobile application
-
- This app provides a simple and familiar interface that allows users to to get started immediately
-
- Allows users to keep their notes organized with labels and colors
-
- Mark important notes so that users will never miss it
-
- Supports both Dark and Light themes, based on user preference
- The landing workspace contains all the code related to the landing page that is built using Qwik
-
- SEO optimized, pre-rendered landing page that allows users to easily understand what Beyojar provides
- Git
- Node.js 16+
- NPM 7+
- Android Studio (Needed only if you want to run the app in an Android emulator)
- Xcode (Needed only if you want to run the app in an iOS emulator)
From your command line:
# Clone this repository
$ git clone https://github.com/kaje94/beyojar
# Go into the repository
$ cd beyojar
# Install dependencies
$ npm installScripts related to running the mobile app:
# Start the expo development server to work on your project by running:
$ npm run start:expo
# Start the expo development server and launch the Android app by running:
$ npm run start:android
# Either an android emulator or an android device with usb-debugging turned on, must be available
# Start the expo development server and launch the IOS app by running:
$ npm run start:ios
# Xcode must to available in order to run this command
# Start the expo development server and launch the expo app in a browser by running:
$ npm run start:webScripts related to building & running the landing page:
# Start the landing page in dev mode by running:
$ npm run start:landing
# Build the landing page in production mode by running:
$ npm run build:landing
# Deploy the landing page build files in localhost by running:
$ npx http-server landing/dist
# Can also use alternatives such as Browsersync, lite-server, serve or static-serverScripts related to linting and formatting:
# Check if there are any linting issues in both mobile and landing workspace by running:
$ npm run lint
# Check & fix fixable linting issues in both mobile and landing workspace by running:
$ npm run lint:fix
# Format other files types such as .json, .md & .css by running:
$ npm run format-rest
# These scripts will also automatically run via the pre-commit hook when you perform a commitScripts related to storybook in the mobile workspace:
# Open storybook in development mode by running:
$ npm run storybook:mobile
# Run storybook tests by running:
$ npm run storybook-test:mobile
# Make sure to have storybook running in dev mode or production mode before running this command
# Build storybook in production mode by running:
$ npm run storybook-build:mobilePlease refer the Contributing.md in order to contribute towards this project
[email protected] · GitHub @kaje94 ·