https://github.com/kaje94/beyojar
Explore this open-source notes app for Android & iOS, crafted with React-Native & Expo. Now available on the Apple App Store and Google Play Store for easy access and convenience
https://github.com/kaje94/beyojar
android android-app appstore expo ios ios-app mobile-app notes notes-app playstore qwik react react-native
Last synced: about 1 year ago
JSON representation
Explore this open-source notes app for Android & iOS, crafted with React-Native & Expo. Now available on the Apple App Store and Google Play Store for easy access and convenience
- Host: GitHub
- URL: https://github.com/kaje94/beyojar
- Owner: kaje94
- License: mit
- Created: 2022-09-10T07:49:26.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-19T09:30:00.000Z (over 3 years ago)
- Last Synced: 2025-03-31T01:22:37.974Z (over 1 year ago)
- Topics: android, android-app, appstore, expo, ios, ios-app, mobile-app, notes, notes-app, playstore, qwik, react, react-native
- Language: TypeScript
- Homepage: https://beyojar.com
- Size: 10.5 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Beyojar
A minimal, open source notes app built with React-Native & Expo.
Introduction •
Prerequisite •
How To Use •
Contributing •
License
## Introduction
- Beyojar is a simple notes taking application built for Android & IOS using [React-Native](https://reactnative.dev/) & [Expo](https://docs.expo.dev)
- The [mobile](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](landing) workspace contains all the code related to the landing page that is built using [Qwik](https://qwik.builder.io/)
- - SEO optimized, pre-rendered landing page that allows users to easily understand what _Beyojar_ provides
## Prerequisite
- [Git](https://git-scm.com)
- [Node.js 16+](https://nodejs.org/en/download/)
- [NPM 7+](http://npmjs.com)
- [Android Studio](https://developer.android.com/studio) (Needed only if you want to run the app in an Android emulator)
- [Xcode](https://developer.apple.com/xcode/) (Needed only if you want to run the app in an iOS emulator)
## How To Use
From your command line:
```bash
# Clone this repository
$ git clone https://github.com/kaje94/beyojar
# Go into the repository
$ cd beyojar
# Install dependencies
$ npm install
```
Scripts related to running the mobile app:
```bash
# 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:web
```
Scripts related to building & running the landing page:
```bash
# 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-server
```
Scripts related to linting and formatting:
```bash
# 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 commit
```
Scripts related to storybook in the mobile workspace:
```bash
# 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:mobile
```
## Contributing
Please refer the [Contributing.md](.github/CONTRIBUTING.md) in order to contribute towards this project
## License
[](LICENSE)
> [a.kajendran@gmail.com](mailto:a.kajendran@gmail.com) ·
> GitHub [@kaje94](https://github.com/kaje94) ·